Basic Polkadot/Substrate UI for interacting with a node. This is the main user-facing application, allowing access to all features available on Substrate chains.
Branch: master
Clone or download
Travis CI
Travis CI [CI Skip] 0.23.30
Latest commit 9a3eede Feb 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
packages [CI Skip] 0.23.30 Feb 16, 2019
test Use ApiPromise instance, replace ApiObservable (#540) Jan 7, 2019
.babelrc.js Support enumerable accounts (#102) Jun 25, 2018
.codeclimate.yml Merge next into master (#529) Dec 21, 2018
.dockerignore Add .dockerignore Aug 12, 2018
.editorconfig Initial commit Apr 17, 2018
.gitignore Submit extrinsics via signAndSend (#585) Jan 11, 2019
.gitlab-ci.yml Initial commit of kubernetes deployment (#616) Jan 18, 2019
.npmignore Initial commit Apr 17, 2018
.nvmrc Merge next into master (#529) Dec 21, 2018
.travis.yml Submit extrinsics via signAndSend (#585) Jan 11, 2019
CHANGELOG.md Re-introduce Compact<Index> transaction support (#574) Jan 9, 2019
Dockerfile Initial commit of kubernetes deployment (#616) Jan 18, 2019
LICENSE Merge next into master (#529) Dec 21, 2018
README.md Move app-rpc into app-toolbox (#637) Jan 22, 2019
babel.config.js Use @babel 7 (#52) May 17, 2018
deployment.template.yml Initial commit of kubernetes deployment (#616) Jan 18, 2019
gh-pages-refresh.sh Collapse sidebar (#700) Feb 12, 2019
jest.config.js Javascript & API console app (#666) Feb 1, 2019
lerna.json [CI Skip] 0.23.30 Feb 16, 2019
package.json [CI Skip] 0.23.30 Feb 16, 2019
postcss.config.js Use @babel 7 (#52) May 17, 2018
tsconfig.json Merge Explorer & Nodeinfo apps (#706) Feb 13, 2019
tslint.json Merge next into master (#529) Dec 21, 2018
types.json Small init changes (static state) (#663) Jan 31, 2019
yarn.lock Fix validatorPrefs input (#721) Feb 16, 2019

README.md

polkadotjs license style npm travis greenkeeper dependency devDependency

@polkadot/apps

A Portal into the Polkadot and Substrate networks. Provides a view and interaction layer from a browser.

This can be accessed as a hosted application via https://polkadot.js.org/apps/ to explorer any of the supported Polkadot and Substrate chains

overview

The repo is split into a number of packages, each representing an application. These are -

  • apps This is the main entry point. It handles the selection sidebar and routing to the specific application being displayed.
  • app-accounts A basic account management app.
  • app-addresses A basic address management app.
  • app-democracy A basic voting app, allowing votes on activate proposals and referendums.
  • app-explorer A simple block explorer. It only shows the most recent blocks, updating as they become available.
  • app-extrinsics Submission of extrinsics to a node.
  • app-settings A basic settings management app, allowing choice of language, node to connect to, and theme
  • app-staking A basic staking management app, allowing staking and nominations.
  • app-nodeinfo Node information and status
  • app-storage A simple node storage query application. Multiple queries can be queued and updates as new values become available.
  • app-toolbox Sumission of raw data to RPC endpoints and utility hashing functions.
  • app-transfer A basic account management app, allowing transfer of DOTs between accounts.

In addition the following libraries are also included in the repo. These are to be moved to the @polkadot/ui repository once it reaches a base level of stability and usability. (At this point with the framework being tested on the apps above, it makes development easier having it close)

  • ui-app A reactive (using RxJS) application framework with a number of useful shared components.
  • ui-signer Signer implementation for apps.
  • ui-react-rx Base components that use the RxJS Observable APIs

development

Contributions are welcome!

To start off, this repo (along with others in the @polkadot family) uses yarn workspaces to organise 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 -

  1. Clone the repo locally, via git clone https://github.com/polkadot-js/apps <optional local path>
  2. Ensure that you have a recent LTS version of Node.js, for development purposes Node >=10.13.0 is recommended.
  3. Ensure that you have a recent version of Yarn, for development purposes Yarn >=1.10.1 is required.
  4. Install the dependencies by running yarn
  5. Ready! Now you can launch the UI (assuming you have a local Polkadot Node running), via yarn run start
  6. Access the UI via http://localhost:3000

There are additional environment UI flags that change both the theme and mode -

  • Running with UI_MODE=light|full switches from a full (the default) to a light mode interface that only has specific applications highlighted.
  • Running with UI_THEME=substrate|polkadot switches from a Polkadot theme (the default) to a Substrate-branded UI

I want to code around

There is a base template availble app-123code that acts as a simple starting point for adding additional apps to the UI. Alternatively if you just want some place where you can write some code, it does the trick.

While it is hidden from the sidebar, it is accessible via http://127.0.0.1:3000/#/123code

Be sure to follow the app-123code/README.md instructions.

Docker

You can run a docker container via -

docker run --rm -it --name polkadot-ui -p 80:80 chevdor/polkadot-ui:latest

To build a docker container containing local changes -

docker build -t chevdor/polkadot-ui:latest .