zhanzehua / aragon

Create and manage decentralized organizations on Ethereum.

Aragon

🌎🚀 Trusted by over 1000 organizations, securing more than $20MM in funds. Try it out.

• 📚 Read the User Guide first, if you have any questions as a user.
• 🏗 If you'd like to develop an Aragon app, please visit the Aragon Developer Portal.
• 📝 Please report any issues and feedback in the Aragon Client channel.
• 🔧 For technical stuff, use this project's issues or join the technical conversation in our Developer hangout channel.
• 📖 To learn more about contributing to the Aragon client itself, please check the contributing guide.
• 🚢 For an overview of what changed with each release, check the releases and changelog.

Quick start

Install with yarn and launch the app with yarn start. By default, the app is configured to connect to the Ethereum Rinkeby testnet.

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

• Ethereum Mainnet: yarn start:mainnet will launch the app, configured to connect to the Ethereum mainnet
• Local development: yarn 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. If you're using the aragonCLI, you'll want to run this to connect to its local chain.

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

More configuration options are available, and depending on your needs, you may find the frontend development setup guide helpful.

Releases

The Aragon client undergoes a number of different deployments, based on build environments, major release timelines, and quality assurance checks.

For more information about each official release, see our releases page.

aragonPM

Regular updates, with incrementing minor or patch versions, are published onto the aragon.aragonpm.eth on-chain repository for all supported Ethereum environments.

These should be seen as "official" builds, whose distributions are secured by IPFS. Most users see this version of the app, due to mainnet.aragon.org and rinkeby.aragon.org pointing to these builds.

Each incremental version released through this pipeline is documented in our releases page.

Secrets

A number of environment secrets are required during publishing and these are sometimes different per network.

You may either specify these secrets as environment variables or use a .env. An Aragon One encrypted file (.env.enc) is included in this repo with the current secrets used in production.

To decrypt:

keybase decrypt -i .env.enc -o .env

To encrypt:

keybase encrypt --team aragonone -i .env -o .env.enc

Nightly / Per-PR builds

Automatic nightly.aragon.org and nightly-rinkeby.aragon.org deployments will occur for each PR and merge to master through Now. These are useful for quickly testing a new feature, change, or hotfix.

The official Now app for Github is set up to publish nightlies against Rinkeby see default Now configuration. Travis is set up to publish nightlies against mainnet (see mainnet Now configuration).

Contributing

👋 Get started contributing with a good first issue.

🎓 You may be interested in the Aragon client architecture guide if you're not familiar with how the project is set up.

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 to Aragon, more information is available in the contributing guide.

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.

Contributors

Thanks goes to these wonderful people (emoji key):

Pierre Bertet 💻	Brett Sun 💻	Gorka Ludlow 💻	Jorge Izquierdo 💻	Luis Iván Cuende 💻 🎨 🤔	Oliver 💻	ßingen 💻
Daniel Norman 💻	John Light 📖 🐛	Tatu 📖	Patricia Davila 🎨 📓	Jouni Helminen 🎨 📓	Luke Duncan 🤔	Daniel Constantin 💻
RJ Ewing 💻	Paul Henschel 💻	Rodrigo Perez 💻	gasolin 💻	Adam Soltys 💻	Arun Kumar 💻	Beer van der Drift 💻
Daniel Caballero 💻	Deam 💻	Ilia Smirnov 📖 🔧	julsar 📖	Pascal Precht 🔧	Rudy Godoy 📖	Yalda Mousavinia 💻
decodedbrain 💻	jvluso 💻	mark g romano 💻	mul53 💻	Jon 💻	Abhinav Sagar 🚧	geleeroyale 📖
Otto G 💻	Adam Boro 💻	Emilio Silva Schlenker 💻	Olivier Sarrouy 💻	delfipolito 💻	Enrique Ortiz 💻	Fabrizio Vigevani 💻
Mathew Cormier 💻	Mick de Graaf 💼	iwaduarte 💻	EC Wireless 💻	owisixseven 🎨	Andy Hook 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Re-usable foundations

Amongst other dependencies, the Aragon client is built upon these packages that you may also find useful for your projects:

• aragonUI: React component library used to build user interfaces within the Aragon design system
• token-amount: utility class for encapsulating and formatting a token amount
• use-inside: React utility that allows a component to be aware of being "inside" the subtree of another component
• use-token: React utility for fetching information related to tokens on Ethereum
• use-viewport: React utility providing the current window size and convenient functions for responsive apps
• use-wallet: React utility aiming to make the integration between your dapp and your users' web3 wallets as straightforward as possible
• web3-react: a simple, maximally extensible React framework for supporting arbitrary web3 wallets