Skip to content

Commit

Permalink
Merge pull request #72 from ResilientApp/SCM-35
Browse files Browse the repository at this point in the history
Static Config Added
  • Loading branch information
aunshx authored Oct 25, 2024
2 parents 1bbf8c3 + 588c1ad commit f868359
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 9 deletions.
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,55 @@
# ResView - ResilientDB Visualizer
<h1>
<img src="https://i.postimg.cc/jd6PkhDs/Res-View-Logo-Dark.png" alt="Logo" width="50" height="50" style="vertical-align: middle; margin-right: 10px;">
<span style="vertical-align: middle;">ResView: The ResilientDB Visualizer</span>
</h1>

![Logo](https://i.postimg.cc/jd6PkhDs/Res-View-Logo-Dark.png)
ResView is a visualizer based on the ResilientDb fabric to show transaction visualizations.

ResView is a visualizer based on the Resilient Db fabric to show transaction visualizations.
#### Check out the [blog](https://aunsh.medium.com/resview-a-pbft-visualizer-based-on-the-resilientdb-blockchain-fabric-3ffaeb2aaee5) to know more

#### Check out the [blog](https://aunsh.medium.com/resview-a-pbft-visualizer-based-on-the-resilientdb-blockchain-fabric-3ffaeb2aaee5) to know more!

## Table of Contents

- [Get Prepared](#get-prepared)
- [Installation and Usage](#installation)
- [Contributing](#contributing)
- [Authors and Contact](#authors-and-contact)
- [License](#license)

## Get Prepared

Before running the ResView application, there are a few other services which need to be ran.

Git clone the ResilientDB backend repository and follow the instructions to set it up:

```bash
git clone https://github.com/apache/incubator-resilientdb
```

To enable different ResView api endpoints and view change service locally, go to service/tools/config/server/server.config in the ResilientDB repository and set:
To enable different ResView api endpoints and view change service locally, go to service/tools/config/server/server.config in the ResilientDB repository and set:

```bash
enable_resview:true
enable_faulty_switch:true
enable_viewchange:true
```

Setup KV Service to run the backend:

```bash
./service/tools/kv/server_tools/start_kv_service.sh
```

Git clone the GraphQL Repository and follow the instructions on the ReadMe to set it up:

Install GraphQL:

```bash
git clone https://github.com/ResilientApp/ResilientDB-GraphQL
```

Setup SDK:

```bash
bazel build service/http_server:crow_service_main

Expand All @@ -47,6 +61,7 @@ With these 2 services running, the ResView front end can now send transactions t
## Installation

Clone this repository and open in a new folder.

```bash
git clone https://github.com/ResilientApp/ResView
```
Expand Down Expand Up @@ -80,14 +95,14 @@ Send transactions to backend using Set and Get fields, display a transaction's c

Pull requests are welcome.

ALWAYS update your changes to a branch and drop a PR.
Please update your changes to a branch and drop a PR.

## Authors
## Authors and Contact

[aunshx](https://github.com/aunshx/)

[saipranav](https://github.com/Saipranav-Kotamreddy/)

## License

[MIT](https://choosealicense.com/licenses/mit/)
[Attribution-NonCommercial 4.0 International](https://creativecommons.org/licenses/by-nc/4.0/)
2 changes: 1 addition & 1 deletion build/static/js/main.b323a686.js.map

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions staticwebapp.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"routes": [
{
"route": "/*",
"serve": "/index.html",
"statusCode": 200
}
],
"navigationFallback": {
"rewrite": "/index.html",
"exclude": ["/images/*.{png,jpg,gif}", "/css/*"]
}
}

0 comments on commit f868359

Please sign in to comment.