Aragon website • Developer Portal • Join our Developer Community • Contribute
The Aragon App is an easy-to-use platform that empowers users to create and manage their Decentralized Autonomous Organizations (DAOs). The application interacts with the Aragon OSx through the integration of the Aragon OSx SDK and the Aragon Governance UI Kit library.
Before setting up the project, ensure you have the following installed:
- Node.js: Version >= 22
- EditorConfig: Ensure your IDE has EditorConfig support enabled
Follow these steps to get the app running on your machine:
- Enable Corepack (one-time setup):
corepack enable- Install the required dependencies by running:
pnpm installNote: pnpm will automatically use the correct Node.js version as configured in the project.
- Create a
.envfile in the root of the project and populate it with the required environment variables. Use the.env.examplefile as a template:
cp .env.example .env- Start the development server with:
pnpm dev- Access the Aragon App by navigating to http://localhost:3000 in your browser.
Other available commands include:
- Lint the code:
pnpm lint- Build the project:
pnpm build- Run tests:
pnpm test"Cannot find module" errors:
- pnpm uses strict dependency resolution
- All imports must be declared in package.json
- Solution:
pnpm add <package-name>
Build script errors:
- Some packages need approval:
pnpm approve-builds - Check
.npmrcforpublic-hoist-patternif needed
Installation issues:
- Clear cache:
pnpm store prune - Reinstall:
rm -rf node_modules && pnpm install
Node version issues:
- pnpm automatically manages Node.js versions
- If issues persist, ensure Corepack is enabled:
corepack enable
The Aragon App supports various environments, each with its unique URL and deployment trigger. Here are the available environments:
| Name | Url | Deployment trigger | Environment file |
|---|---|---|---|
| Local | http://localhost:3000 | - | .env.local |
| Preview | [Generated by the workflow] | Manual by adding the Preview label on PRs |
.env.preview |
| Develop | https://dev.app.aragon.org | Automatic on main branch push |
.env.develop |
| Staging | https://stg.app.aragon.org | Manual through the Staging Github workflow |
.env.staging |
| Production | https://app.aragon.org | Manual through the Release Github workflow |
.env.production |
The Aragon App is built using the following tools to ensure a seamless user experience:
For more technical information about the Aragon App, please check the Aragon App Documentation.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.
If you believe you've found a security issue, we encourage you to notify us. We welcome working with you to resolve the issue promptly. Security Contact Email: [email protected] Please do not use the issue tracker for security issues.
For more information about Aragon and its ecosystem, please visit the Aragon website and explore our Developer Portal. Join our Developer Community to stay updated and contribute to the growth of decentralized governance.