Skip to content

Commit

Permalink
b
Browse files Browse the repository at this point in the history
  • Loading branch information
kukabi committed Sep 18, 2023
1 parent 379df17 commit 172a630
Showing 1 changed file with 45 additions and 2 deletions.
47 changes: 45 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,51 @@
<a href="https://chainviz.app" target="_blank"><img width="100%" src="https://raw.githubusercontent.com/helikon-labs/chainviz/development/readme-files/chainviz-v1-screenshot-01.png"></a>
</p>

You may find the release article on [Medium](https://medium.com/helikon/introducing-chainviz-v1-a-new-kind-of-block-explorer-6b9f4ed83e8d).

[Chainviz](https://chainviz.app) visualizes the following aspects of the Kusama relay chain and validators in real-time:

- Active validators in a 3D representation and list format.
- Block production process.
- Block list, and block contents on click.
- Parachains, and their assigned validators.
- Recent XCM transfer messages, and message contents (powered by [Polkaholic API](https://docs.polkaholic.io/#introduction)).
- Basic network and staking data.
- Validator details panel, where the user can observe the validator in real-time.

Chainviz uses the services provided by the [SubVT backend](https://github.com/helikon-labs/subvt-backend/tree/development), part of [SubVT](https://subvt.io), a project supported by the Kusama Treasury and W3F Grants.

Please view the [alpha version](https://alpha.chainviz.app) repository [here](https://github.com/helikon-labs/chainviz).

---
## Build & Run

### Development

Follow the commands below to run the application in development mode with live code update.

```
git clone https://github.com/helikon-labs/chainviz.git
cd chainviz
npm install
npm run dev
```

### Docker

You may run the Docker image locally using the following commands.

```
git clone https://github.com/helikon-labs/chainviz.git
cd chainviz/docker
docker build -t helikon/chainviz:1.0.0 --no-cache -f ./chainviz.dockerfile ..
```

Docker is going to build the docker image and make it available locally. Then you can run the built Docker image using the command:

```
cmd
```

## Test

🚧 This project is in heavy progress, and this repo is subject to frequent change.
Please view [TEST.md](./TEST.md) for testing details.

0 comments on commit 172a630

Please sign in to comment.