gtcr
gtcr copied to clipboard
Web client for the kleros generalized token curated list
Generalized Token Curated List
Get Started
- Clone this repo;
- Duplicate
.env.example
and rename it to.env
. Fill the environment variables. - Run
yarn
to install dependencies and thenyarn build:theme && yarn start
to start the dev server.
Tested on node version 10.
Supporting New Field Types
The Generalized TCR clients can learn how to parse and decode data stored onchain by reading what are the field types of each column from the metadata
object stored on the meta evidence file.
Important
To support a new field type, it is required to update the evidence display interface as well. Otherwise it might not know how to parse it and crash on arbitrator clients, preventing them from properly judging a case.
The evidence display interface code of the Generalized TCR can be found at https://github.com/kleros/gtcr-injected-uis.
Other Scripts
-
yarn format
- Lint, fix and prettify all the project. -
yarn run cz
- Run commitizen. -
yarn run build
- Create a production build.
Netlify Deployment
When setting up the repo for publishing on netlify:
- Fill the env variables in netlify.toml;
- Set the following environment variables on the site's build config in netlify's dashboard:
REACT_APP_RPC_URLS
REACT_APP_FORMATIC_API_KEYS
REACT_APP_NOTIFICATIONS_API_URL