Astro Stats API

A backend middleware for Astro Stats providing access to multiple DAO metrics.

Technology stack

• Blockchain: NEAR
• Smart Contracts: Sputnik DAO Factory V2, Sputnik DAO V2
• Package manager: Yarn
• Core programming language: TypeScript
• Application framework: React
• Code quality: Eslint, Prettier
• Containers: Docker
• Deployment: Kubernetes

Status

Change Log

Links

Development

Testnet: https://api-stats.testnet.app.astrodao.com/docs/

Production

Mainnet: api-stats.app.astrodao.com/docs/

Getting Started

Local Development

1. Clone the repo:

git clone git@github.com:near-daos/astro-stats-api.git

2. Open the repo folder:

cd astro-stats-api

3. Install dependencies:

yarn install

4. Add .env.local to the root folder with required environment variables described in .env.

5. Run dev docker compose:

docker-compose -f docker-compose-dev.yml up

Please make sure that Docker has been installed on your local machine.

6. Run specific service you need:

• Aggregator: yarn start-aggregator:dev
• API: yarn start-api:dev