A fork of Polkadot JS Apps, a portal into the Polkadot SDK networks. Provides a view and interaction layer from a browser.
Important If you are a chain developer and would like to add support for your chain to the UI, all the local configuration (API types, settings, logos) can be customized in the apps-config package, complete with instructions of what goes where.
The repo is split into a number of packages, each representing an application.
Contributions are welcome!
To start off, this repo uses yarn workspaces to organize the code. As such, after cloning dependencies should be installed via yarn, not via npm, the latter will result in broken dependencies.
To get started -
- Clone the repo locally, via
git clone https://github.com/helikon-labs/chainconsole <optional local path> - Ensure that you have a recent LTS version of Node.js, for development purposes Node >= 16 is recommended.
- Ensure that you have a recent version of Yarn, for development purposes Yarn >= 1.22 is required.
- Install the dependencies by running
yarn install --frozen-lockfile - Ready! Now you can launch the UI (assuming you have a local Polkadot Node running), via
yarn run start - Access the UI via http://localhost:3000
You can run a docker container via -
docker run --rm -it --name chainconsole -e WS_URL=ws://someip:9944 -p 80:80 helikon/chainconsole:latest
To build a docker container containing local changes -
docker build -t helikon/chainconsole -f docker/Dockerfile .
When using these Docker commands, you can access the UI via http://localhost:80 (or just http://localhost)