https://github.com/kleros/gtcr-injected-uis
Various injected components for displaying evidence.
https://github.com/kleros/gtcr-injected-uis
curated-list curated-lists-v1 frontend
Last synced: about 2 months ago
JSON representation
Various injected components for displaying evidence.
- Host: GitHub
- URL: https://github.com/kleros/gtcr-injected-uis
- Owner: kleros
- License: mit
- Created: 2019-10-16T15:37:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-22T23:38:41.000Z (over 2 years ago)
- Last Synced: 2025-03-22T16:51:06.013Z (2 months ago)
- Topics: curated-list, curated-lists-v1, frontend
- Language: JavaScript
- Homepage:
- Size: 1.43 MB
- Stars: 0
- Watchers: 10
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Curate Injected UIs
Service and database for handling Generalized TCR contract events.
## Get Started
1. Clone this repo.
2. Duplicate `.env.example`, rename it to `.env` and fill in the environment variables.
3. Run `yarn` to install dependencies and then `yarn start` to run the UI in development mode.
Remeber to provide dispute data on the URL. It should be a JSON object containing the arbitrator and arbitrable addresses, the disputeID, RPC endpoint and chainID as follows:
```
?{"arbitrableContractAddress":"0xdeadbeef...","arbitratorContractAddress":"0xdeadbeef...","disputeID":"111","jsonRpcUrl":"http://localhost:8545","chainId":"1"}
```
### Classic or Light
This codebase has two different iframes: one for classic curate (iframes/item-details) and one for light curate (iframes/light-item-details). You must pick one to build your evidence display.
You can do so by changing the component inside bootstrap/app.jss
### Fallback Provider
Keep in mind that the hardcoded, fallback provider has a specific chainId. Remember to update it if you are building for a specific chain.
## Deploy
This interface is meant to be deployed to IPFS.
To do so, you should:
1. Copy the `.env.example` file to `.env`:
```sh
cp .env.example .env
```
2. Set the appropriate environment variables.
3. Bundle the app for production:
```sh
yarn build
```
4. Zip the `dist/` directory.
5. Send the zip file to Kleros IPFS host server through SSH (ask a team member if you are not sure how).
6. Unzip the file and jump to the folder.
7. Add the contents of the folder to IPFS:
```sh
ipfs add -w -r .
```
8. The `evidenceDisplayURI` will be `/ipfs/`
## Other Scripts
- `yarn format` - Lint, fix and prettify all the project.
.js files with styled components and .js files.
- `yarn run cz` - Run commitizen.