Skip to content

Commit 333acef

Browse files
authored
Apply all logos via uiLogo (polkadot) (#8956)
* Apply all logos via uiLogo (polkadot) * Adjust * Adjust README
1 parent 7b73135 commit 333acef

File tree

8 files changed

+88
-111
lines changed

8 files changed

+88
-111
lines changed

README.md

+6-23
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,11 @@ If you run one or more IPFS node(s), pinning the UI (which only gets updated on
88

99
**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](packages/apps-config#README.md), complete with instructions of what goes where.
1010

11-
## overview
12-
13-
The repo is split into a number of packages, each representing an application. These are -
14-
15-
- [apps](packages/apps/) This is the main entry point. It handles the selection sidebar and routing to the specific application being displayed.
16-
- [apps-electron](packages/apps-electron/) Desktop app running [apps](packages/apps/).
17-
- [page-accounts](packages/page-accounts/) A basic account management app.
18-
- [page-address-book](packages/page-address-book/) A basic address management app.
19-
- [page-democracy](packages/page-democracy/) A basic voting app, allowing votes on activate proposals and referenda.
20-
- [page-explorer](packages/page-explorer/) A simple block explorer. It only shows the most recent blocks, updating as they become available.
21-
- [page-extrinsics](packages/page-extrinsics/) Submission of extrinsics to a node.
22-
- [page-js](packages/page-js/) An online code editor with [@polkadot-js/api](https://github.com/polkadot-js/api/tree/master/packages/api) access to the currently connected node.
23-
- [page-settings](packages/page-settings/) A basic settings management app, allowing choice of language, node to connect to, and theme
24-
- [page-staking](packages/page-staking/) A basic staking management app, allowing staking and nominations.
25-
- [page-storage](packages/page-storage/) A simple node storage query application. Multiple queries can be queued and updates as new values become available.
26-
- [page-toolbox](packages/page-toolbox/) Submission of raw data to RPC endpoints and utility hashing functions.
27-
- [page-transfer](packages/page-transfer/) A basic account management app, allowing transfer of Units/DOTs between accounts.
28-
29-
In addition the following libraries are also included in the repo. These are to be moved to the [@polkadot/ui](https://github.com/polkadot-js/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)
30-
31-
- [react-components](packages/react-components/) A reactive (using RxJS) application framework with a number of useful shared components.
32-
- [react-signer](packages/react-signer/) Signer implementation for apps.
33-
- [react-query](packages/react-query) Base components that use the RxJS Observable APIs
11+
12+
## Overview
13+
14+
The repo is split into a number of packages, each representing an application.
15+
3416

3517
## Development
3618

@@ -47,6 +29,7 @@ To get started -
4729
5. Ready! Now you can launch the UI (assuming you have a local Polkadot Node running), via `yarn run start`
4830
6. Access the UI via [http://localhost:3000](http://localhost:3000)
4931

32+
5033
## Docker
5134

5235
You can run a docker container via -

packages/apps-config/README.md

+6-24
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
General config for various services, including settings, external links & types. This is a central source of all the configuration settings that can be tweaked. This also means that it can be customized (via PR) to support any additional chains. The internals are split into a number of settings -
44

55
- [api](./src/api) - Here you can add any chain or node-type specific types configuration. When added, it means that when the UI connects to either a runtime with a spec name, or a chain with a specific name, the types will be automatically added to the API as used in the app.
6-
- [links](./src/links) - These are all links to external providers such as explorers. This information is used anywhere where there is an external link to determine the providers for these links.
7-
- [settings](./src/settings) - These are used in dropdowns, specifically under the settings page.
8-
- [ui](./src/ui) - Logos & color settings for chain and node spec specific overrides. This means that when the runtime/chain is detected, the specific logo would be used.
6+
- [endpoints](./src/endpoints) - Configuration for specific per-type chain endpoints.
97

108
Customization for each of these are discussed next.
119

@@ -18,26 +16,10 @@ The API config can be done in one of two ways -
1816

1917
The actual type definitions you should be familiar with, it is exactly the same as you would upload via the settings page in JSON, or as detailed in the [API types pages](https://polkadot.js.org/api/start/types.extend.html#extending-types).
2018

21-
## Links
2219

23-
We are not going to spend too much time here, since it is generally applicable to explorers and like services. However, should you run one of these services, you can take a look at the existing configs and customize for your setup.
20+
## Endpoints
2421

25-
## Settings
26-
27-
There are 2 general areas of interest here -
28-
29-
- [endpoints](./src/settings) - This is where we can add additional endpoints to appear in the dropdowns. We would like to keep this to mostly live networks, although based on demand can probably extend to a testing-only section as well.
30-
- [ss58](./src/settings) - Should you wish to add your ss58Format to the settings dropdown, this is where the configuration take place
31-
32-
## UI
33-
34-
These are self-explanatory and config here actually does get used in other parts as well. Basically the information here is broken down into a couple of categories -
35-
36-
- [colors](./src/ui/colors.ts)
37-
- color configuration based on chain
38-
- [identityIcon](./src/ui/identityIcons)
39-
- specific identityIcon to use based on node name
40-
- [logos](./src/ui/logos)
41-
- chains - Specific logos when connecting to a specific chain
42-
- nodes - Logos that are used when connecting to a specific runtime spec type (catch-all)
43-
- named - These logos are used as overrides when we pass an explicit logo name
22+
1. Add your chain logo (if available) to either `ui/logos/chains` or `ui/logos/nodes` (the second is generally used)
23+
2. Run the image build command to generate an inline version via `yarn build:images`
24+
3. Add your chain to `endpoints/{production, productionRelay, testing, testingRelay*}` as applicable for your deployment
25+
3. The `uiColor` specifies the chain color, the `uiLogo` (importted from generated), specifies the specific logo

0 commit comments

Comments
 (0)