Aragon

📝 Please report support and feedback related issues at the Aragon Chat #feedback channel.

🔧 For technical stuff, use this project's issues or join the technical conversation in our #dev channel.

🦋 For an overview of what changed in every version check the changelog

Contributing

Please note that all of the code is still undocumented, and no contribution guidelines are in place.

Contributions are welcome, just beware of the dragons. 🐲

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 our mainnet deployment
Local development: npm run start:local will launch the app, configured to connect to our aragen local development environment. It will also use the local IPFS daemon, if it detects one exists.

Note: Windows users may need to install the windows-build-tools before installing this project's dependencies.

Environment options

The app can be configured in a number of ways via environment variables:

ARAGON_DEMO_DAO: Address of the demo organization suggested to users during onboarding
REACT_APP_DEFAULT_ETH_NODE: Url of the default Ethereum node to read blockchain data from (must be WebSocket protocol). If you intend to connect to a local ganache instance, by default you should set this to ws://localhost:8545.
REACT_APP_ENS_REGISTRY_ADDRESS: Address of the ENS registry that APM repos were registered on. If you've deployed aragonOS to a local network, you can find the ENS registry's address in the migration's console output.
REACT_APP_ETH_NETWORK_TYPE: Expected network type to connect to. Either one of main, rinkeby or local.
REACT_APP_IPFS_GATEWAY: Url of the IPFS gateway to load APM repos from. If you intend to connect to a local IPFS daemon, by default you should set this to http://localhost:8080/ipfs
REACT_APP_ASSET_BRIDGE: Which source to load app frontend assets from. Can be one of ipfs (uses the configured IPFS gateway) or local (local development servers, running on localhost:300x). If you intend to serve assets from a local IPFS daemon, you should set this to ipfs.

Without any settings, the app is configured to connect to our Rinkeby deployment fetching assets from IPFS.

Issues

If you come across an issue with Aragon, do a search in the Issues tab of this repo and the Aragon Apps Issues 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.

MarkGeeRomano / aragon