Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/resilientapp/resview
Visualizer for the ResilientDB Blockchain fabric
https://github.com/resilientapp/resview
blockchain resilientdb visualization
Last synced: 11 days ago
JSON representation
Visualizer for the ResilientDB Blockchain fabric
- Host: GitHub
- URL: https://github.com/resilientapp/resview
- Owner: ResilientApp
- Created: 2023-11-12T00:38:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-17T00:11:57.000Z (3 months ago)
- Last Synced: 2024-09-17T21:36:15.876Z (3 months ago)
- Topics: blockchain, resilientdb, visualization
- Language: JavaScript
- Homepage: https://resview.resilientdb.com/
- Size: 7.85 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ResView: The ResilientDB Visualizer
ResView is a visualizer based on the ResilientDb 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
## 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:
```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
bazel-bin/service/http_server/crow_service_main service/tools/config/interface/service.config service/http_server/server_config.config
```
With these 2 services running, the ResView front end can now send transactions to the ResilientDB framework.
## Installation
Clone this repository and open in a new folder.
```bash
git clone https://github.com/ResilientApp/ResView
```
Create a .env file in the root directory with the following contents.
```bash
REACT_APP_SEND_POST_URL = "http://127.0.0.1:18000/v1/transactions/commit"
REACT_APP_SEND_GET_URL = "http://127.0.0.1:18000/v1/transactions/"
REACT_APP_DEFAULT_LOCAL = "http://localhost:"
REACT_APP_DEFAULT_LOCAL_PORT = 18501
REACT_APP_SOCKET_URL_EP = "/consensus_data"
REACT_APP_REPLICA_STATUS_EP = "/get_status"
```
Run the below command to install all required packages
```bash
npm install --force
```
Run the below code to start the app and load the script.
```bash
npm run start
```
Send transactions to backend using Set and Get fields, display a transaction's consensus data in the graphs, choose which transaction to view using choose transaction field.
## Contributing
Pull requests are welcome.
Please update your changes to a branch and drop a PR.
## Authors and Contact
[aunshx](https://github.com/aunshx/)
[saipranav](https://github.com/Saipranav-Kotamreddy/)
## License
[Attribution-NonCommercial 4.0 International](https://creativecommons.org/licenses/by-nc/4.0/)