Aragon website • Developer Portal • Join our Developer Community • Contribute

AragonX App Backend

The AragonX App Backend is a core component of the Aragon ecosystem, designed to index data from blockchain events, emitted by Aragon smart contracts. It provides an API service that enables fast and easy access to this data, facilitating efficient data retrieval for Aragon App and external applications.

Prerequisites

• Docker (https://docs.docker.com/install)
• NodeJS find version in .nvmrc file (prefer install with https://github.com/nvm-sh/nvm)
• MongoDB v7 (prefer install with [https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-os-x/))
• IDE (prefer https://www.jetbrains.com/webstorm/download)

Getting Started

Follow these steps to set up the Aragon App-Backend locally:

Clone repository

git clone https://github.com/aragon/app-backend.git

Install the project's dependencies:

The project uses the pnpm version defined on the packageManager property of the package.json file, enable Corepack to automatically use the correct version:

corepack enable
pnpm install

Initialize the git hooks (the automatic running of the prepare script is disabled in pnpm):

pnpm prepare

Environment

You can set environment variables in the .env file, you can find examples in .env.sample

Run locally

• Run Aragon API

pnpm service:aragon-api

• Run Aragon Indexer

pnpm service:aragon-indexer

• Run Aragon Rates

pnpm service:aragon-rates

• Run Aragon Admin API

pnpm service:aragon-admin-api

Run with Docker

• Run dependencies (mongoDb)

pnpm docker:unit-dep-dependencies

• Run all services

pnpm docker:services

• Run only Aragon API

docker-compose up --build -d service-aragon-api

• Run only Aragon Indexer

docker-compose up --build -d service-aragon-indexer

• Run only Aragon Rates

docker-compose up --build -d service-aragon-rates

• Run only Aragon Admin API

docker-compose up --build -d service-aragon-admin-api

Access the Aragon App by opening http://localhost:3000 in your web browser.

Tests

• Format all files

pnpm format:fix

• Lint the code

pnpm lint

• Unit Test

pnpm test:unit

• Unit Test with coverage

pnpm test:unit:coverage && pnpm test:coverage:check

Contributing

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.

Security

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: sirt@aragon.org

Please do not use the issue tracker for security issues.

Learn More

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.

License

GNU AGPLv3