README.md

Aragon Court Dashboard

Aragon Court handles subjective disputes requiring judgment from human guardians.

• 📚 Read the User Guide first, if you have any questions as a user.
• 📝 Please report any issues and feedback in the support channel on Discord.
• 🔧 For technical discussions, use this project's issues or join the technical conversation in the hacker hangout channel on Discord.
• 📖 To learn more about contributing to the Aragon Court Dashboard, please check the contributing guide

Quick start

npm start will launch the app, configured to connect to our Rinkeby deployment.

For connecting to other chains / deployments, a few useful npm scripts are provided:

• Mainnet: npm run start:mainnet will launch the app, configured to connect to Aragon Court's mainnet deployment
• Local: npm run start:local will launch the app, configured to connect to the local devchain.

Other configuration options are also available.

Local development:

In order to start the dashboard locally, you will need to setup a few processes first.

• Start ganache devchain
• Deploy contracts to devchain
• Deploy subgraph instance

For a detailed guide on how to achieve this, see more instructions here.

You can also setup the court services, which include some automation for auto-revealing commitments, penalty settlements and heartbeats. In order for auto-reveals to work, you will need also to setup the court server.

To start populating the court with disputes, you can use the CLI tool.

Contributing

Before explaining how you can contribute, It's worth mentioning that we use develop branch as the default one. This makes it easier for us to have all the latest, development changes without affecting the current production version. Though, We don't use release branches to make the process a little bit easier !

• Pushing to develop branch via PR deploys changes to testing environments(currently only rinkeby).
• Pushing to master branch via PR from develop deploys changes to production servers(mainnet).
• Pushing to master|develop directly will be restricted to make sure the PR's are reviewed.
• Creating PRs end up in relation to develop by default.

This means that after you clone the project, the branch by default will be set to develop which can be unstable. So, if you want to start from the stable version, make sure to switch to master branch.

👋 Get started contributing with a good first issue.

Don't be shy to contribute even the smallest tweak. 🐲 There are still some dragons to be aware of, but we'll be here to help you get started!

For other details about contributing here, more information is available in the contributing guide.

Issues

If you come across an issue with the Court Dashboard, do a search in the Issues tab of this repo to make sure it hasn't been reported before. Follow these steps to help us prevent duplicate issues and unnecessary notifications going to the many people watching this repo:

• If the issue you found has been reported and is still open, and the details match your issue, give a "thumbs up" to the relevant posts in the issue thread to signal that you have the same issue. No further action is required on your part.
• If the issue you found has been reported and is still open, but the issue is missing some details, you can add a comment to the issue thread describing the additional details.
• If the issue you found has been reported but has been closed, you can comment on the closed issue thread and ask to have the issue reopened because you are still experiencing the issue. Alternatively, you can open a new issue, reference the closed issue by number or link, and state that you are still experiencing the issue. Provide any additional details in your post so we can better understand the issue and how to fix it.