Aragon Protocol backend

This mono-repo includes a set of sub-repos that are in charge of different parts of the whole Aragon Protocol backend:

• app: This repo provides a React app as the frontend app of the Aragon Protocol backend
• cli: This repo provides a CLI tool with a set of commands to interact with an Aragon Protocol instance.
• server: This repo provides the backend server in charge of setting up a database and exposing a set of endpoints that will complement the functionality exposed by the smart contracts.
• services: This repo provides a set of background workers in charge of maintaining those things that could be done automatically for Aragon Protocol.
• shared: This repo provides a set of components shared among all the sub-repos of this mono-repo.

To understand better about these repos, you will find detailed information about them on their own READMEs. However, you can follow the following guide to understand you to set up everything locally:

Local set up

Development environment is configured using docker-compose.

First make sure to create your own .env:

cp .env.sample .env

Docker setup includes a Grafana dashboard for logs and metrics, which requires a Docker plugin:

docker plugin install  grafana/loki-docker-driver:latest --alias loki --grant-all-permissions

Finally, spin up docker containers with:

docker-compose up --build -d

• Rest API is available at http://localhost:3000
• Grafana dashboard is available at http://localhost:5000

Local tests can then be run using:

docker-compose exec test yarn workspace @aragon/protocol-backend-server build
docker-compose exec test yarn test:server
docker-compose exec test yarn test:services

When finished remove the containers with:

docker-compose down

Grafana dashboard updates

To update the dashboard, click Ctrl+S > Copy JSON to clipboard and overwrite the file in monitoring/grafana/provisioning/dashboards/protocol-backend.json.

CI/CD

For CI/CD we are using GitHub Actions.

1. Testnet CI/CD

• For automated tests -> on every non-master commit
• For deploying to staging server -> on every commit in the development branch

2. Mainnet CI/CD

For automated tests and deploying to production when creating v* tags in the master branch.

Deployments can be triggered using lerna:

yarn lerna version [ major | minor | patch ]

3. Dashboard CI/CD

For pushing the Grafana dashboard on any change in development/master branch.

4. Emails / Emails staging

For synchronizing ./emails with Postmark