Forked from Joystream/joystream https://github.com/Joystream/joystream

Jaco Greeff 94a193cd72 Introduce React.memo for react-params (#2403) 5 years ago
.github a3842bb5fe Add yarn matrix (#2398) 5 years ago
.vscode 7bf992a1bb Remove non-working CI cache (#2387) 5 years ago
.yarn 7bf992a1bb Remove non-working CI cache (#2387) 5 years ago
packages 94a193cd72 Introduce React.memo for react-params (#2403) 5 years ago
scripts 562e11dc06 Bump deps (#2091) 5 years ago
test 0e2265ff70 Some initial pre-eslint cleanups (#1383) 5 years ago
.123trigger 87a8b6ffdb Update .123trigger 5 years ago
.babelrc.js 078e2e431a Support enumerable accounts (#102) 6 years ago
.codeclimate.yml 4f96fc0d3f Merge next into master (#529) 6 years ago
.dockerignore 17f6dd6083 Add .dockerignore 6 years ago
.editorconfig d85ce9c263 Initial commit 7 years ago
.eslintignore 2a4d761e0f Added parser to extract i18n strings (#1710) 5 years ago
.eslintrc.js 64edeaefd1 Bump dev (#2276) 5 years ago
.gitignore 7bf992a1bb Remove non-working CI cache (#2387) 5 years ago
.gitlab-ci.yml 7707e2df1c Fix container build (#1456) 5 years ago
.npmignore d85ce9c263 Initial commit 7 years ago
.nvmrc 4f96fc0d3f Merge next into master (#529) 6 years ago
.yarnrc.yml 7bf992a1bb Remove non-working CI cache (#2387) 5 years ago
BOUNTIES.md 63944662a1 Additional requests for working on bounties (#1704) 5 years ago
CHANGELOG.md 5d9161d6df 0.39 (#2220) 5 years ago
CONTRIBUTING.md 449310e0c9 Don't pass UI_MODE/UI_THEME via env (#769) 6 years ago
Dockerfile fdd66e7950 Build only apps component via docker (#2231) 5 years ago
LICENSE 4f96fc0d3f Merge next into master (#529) 6 years ago
README.md 5a849c9e3b fix tiny typo (#2399) 5 years ago
babel.config.js 64edeaefd1 Bump dev (#2276) 5 years ago
deployment.extras.yml 75d901136f CI: add file for substrate-ui and substrate-ui-light domains (#767) 6 years ago
deployment.template.yml 535232457f Initial commit of kubernetes deployment (#616) 6 years ago
i18next-scanner.config.js 3afceac9d1 Parachains app (#2308) 5 years ago
jest.config.js 315995d6bf Rename app-* folders to page-* (#2318) 5 years ago
lerna.json f6227a5933 [CI Skip] 0.40.0-beta.135 5 years ago
package.json 94a193cd72 Introduce React.memo for react-params (#2403) 5 years ago
tsconfig.json 315995d6bf Rename app-* folders to page-* (#2318) 5 years ago
types.json a8ed300dc4 Small init changes (static state) (#663) 6 years ago
yarn.lock 94a193cd72 Introduce React.memo for react-params (#2403) 5 years ago

README.md

polkadotjs license npm beta maintainability

@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

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.

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.
  • page-accounts A basic account management app.
  • page-address-book A basic address management app.
  • page-democracy A basic voting app, allowing votes on activate proposals and referenda.
  • page-explorer A simple block explorer. It only shows the most recent blocks, updating as they become available.
  • page-extrinsics Submission of extrinsics to a node.
  • page-js An online code editor with @polkadot-js/api access to the currently connected node.
  • page-settings A basic settings management app, allowing choice of language, node to connect to, and theme
  • page-staking A basic staking management app, allowing staking and nominations.
  • page-storage A simple node storage query application. Multiple queries can be queued and updates as new values become available.
  • page-toolbox Submission of raw data to RPC endpoints and utility hashing functions.
  • page-transfer A basic account management app, allowing transfer of Units/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)

  • react-components A reactive (using RxJS) application framework with a number of useful shared components.
  • react-signer Signer implementation for apps.
  • react-query 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 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 -

  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

I want to code around

There is a base template available page-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 page-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 .

When using these Docker commands, you can access the UI via http://localhost:80 (or just http://localhost)