neptune/ghost-portal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document UI_MODE & UI_THEME flags (#320)

Browse Source
This commit is contained in:
Jaco Greeff 2018-09-18 10:42:02 +02:00 committed by GitHub
parent 94d4a958dc
commit 3e881c8e25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -52,7 +52,12 @@ To get started -
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](http://localhost:3000)
Alternatively, should you not have a local Node, you can connect to a remote node (POC-2 network, although not fully up-to-date with features) with the `WS_URL` parameter. For eample - the apps entry point can be launched with a WebSocket connection to Polkadot PoC-1 with `WS_URL=wss://poc-2.polkadot.io:9944 yarn run start` and accessing the application of [http://localhost:3000](http://localhost:3000)
Should you not run a local Node, you can connect to a remote node on the POC-2 network with the `WS_URL` environment variable. For example - the apps entry point can be launched with a WebSocket connection to Polkadot POC-2 with `WS_URL=wss://poc-2.polkadot.io:9944 yarn run start` and accessing the application of [http://localhost:3000](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
## demos