This repository contains the following apps:
- Finance: Send payments and manage expenses with budgeting.
- Survey: Create polls to gauge community opinions.
- Tokens: Manages organization tokens.
- Vault: Securely owns and manages tokens on behalf of a DAO.
- Voting: Create votes that execute actions on behalf of token holders.
Each of the individual apps come with a frontend that is intended to be installed and used through the Aragon client.
You can read more about how each of the individual apps work in the Aragon user guide.
The following apps are still under development, and not ready for production deployment yet:
- Payroll: Manages employees' payrolls.
npm install
This installs global package dependencies and also bootstraps the entire monorepo through lerna.
Note: the monorepo is set up in such a way that you must install it through a
lerna bootstrap(done automatically after annpm install).If you're only interested in the contract dependencies, and not the frontends, you can use
INSTALL_FRONTEND=false npm installinstead.If you're only interested in bootstrapping one package, you can use
npx lerna bootstrap --scope @aragon/<package> --include-filtered-dependencies
Running tests on all apps can be done by running npm run test at the root directory (note that running all of the tests can take a significant amount of time!).
Running tests of an individual app can be done by running npm run test inside an individual app's directory, or through the selective npm run test:<app> scripts.
By default, tests are run on an in-memory instance of testrpc.
For some introductory information on what an Aragon app is, and how to build one, please read through the Aragon stack introduction and Your first Aragon app. The aragonAPI documentation is also available as a reference.
👋 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 more details about contributing to Aragon, please check the contributing guide.
If you come across an issue with Aragon, do a search in the Issues tab of this repo and the Aragon client's 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.
For help and support, feel free to contact us at any time on our Spectrum App development channel.