https://github.com/paritytech/governance-ui
https://github.com/paritytech/governance-ui
governance polkadot
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/paritytech/governance-ui
- Owner: paritytech
- License: gpl-3.0
- Archived: true
- Created: 2022-11-17T13:19:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T08:24:40.000Z (over 1 year ago)
- Last Synced: 2025-05-08T00:13:00.146Z (9 months ago)
- Topics: governance, polkadot
- Language: TypeScript
- Homepage:
- Size: 3.5 MB
- Stars: 18
- Watchers: 2
- Forks: 55
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Archive
This repo is no longer maintained. Please have a look at its new home
https://github.com/polkassembly/governance-ui for updates and contributions.
Polkadot Delegation Dashboard is a [PWA](https://web.dev/learn/pwa/) - or Progressive Web App - with a focus on efficiency and offline support in the context of [Web3](https://polkadot.network/).
As a pure web application, it doesn't depend on remote backend to operate but connects to [Polkadot](https://polkadot.network/) nodes.
Some data will be fetched to enhance the experience from `github.com` and `polkassembly.io/`, although the plan short term is to become fully decentralized.
# Use
## Register as a delegate
Anyone can register themselves as a delegate.
To add a new delegate, edit [this file](assets/data/polkadot/delegates.json) and push a pull request. Once approved, changes will be transparently picked up and made available to anyone in the application.
The following table outlines the structure of a `delegate` entry:
| Element | Key | Required | Notes |
| ---------------- | ------------ | -------- | ------------------------------------------------------------------------------------------- |
| Delegate Name | `name` | Yes | The chosen name of the delegate. |
| Delegate Address | `address` | Yes | The chain address of the delegate. |
| Manifesto | `manifesto` | Yes | A description of your goals as a delegate. Supports markdown. |
# Build
The full website can be started using `yarn build`. `PUBLIC_URL` can be set to the final root URL for the considered deplyment environment if required.
# Development
A local dev environment can be started using `yarn dev`.
## Testing
Unit tests can be run via `yarn test:unit`.
Run end-to-end tests via the following steps:
```shell
# Setup
yarn
npx playwright install
# Run webapp in a dedicated tab
yarn dev
cd test/
# Run chain in a dedicated tab
yarn zombienet:native
# Launch tests
URL=http://127.0.0.1:1234/?rpc=ws://127.0.0.1:9984 yarn test:e2e
```
## Using containers
You may build a container using:
```
./scripts/build-container.sh
```
then run your container with:
```
podman run --d -p 8080:80 localhost/polkadot-delegation-dashboard
```
and access the Delegation Dashboard at http://localhost:8080/