kleros-front
kleros-front copied to clipboard
Kleros GUI
Kleros front
Table of Contents
- Getting started
- Install dependencies
- Run application
- POC Ethereum network
- Storybook
- Local
- Remote
- Linter
- Invision
- Contributing
Getting started
Install dependencies
yarn
Run application
Before running the app you'll need to install Metamask and use the Kovan Test Network.
yarn start
Go to http://localhost:3000.
Run test
yarn test
POC Ethereum network
For the POC, the smart contract are deployed on the kovan testnet network.
To get some kovan token, you can follow this link https://github.com/kovan-testnet/faucet.
Storybook
We use Storybook.
Local
yarn run storybook
Go to http://localhost:9009/.
Remote
Update Storybook:
yarn run deploy-storybook
Go to https://kleros.io/kleros-front
Linter
yarn run lint # check lint
yarn run lint-fix # fix lint
Documentation
Build documentation
yarn run build-docs
Open documentation
yarn run docs
Invision
Go there.
Contributing
We welcome contributions from anyone on the internet. Check out our contributing guide to learn more on how to get involved.