Skip to content
Blue Dots Economy Documentation

Local And Docker

This is the recommended development setup.

Why This Mode

Section titled “Why This Mode”

Use this when:

  • you are developing the API
  • you are writing or testing schemas
  • you want predictable local Postgres and Redis

Start The Backing Services

Section titled “Start The Backing Services”
Terminal window
docker compose up -d db redis

Example Local Environment

Section titled “Example Local Environment”
Terminal window
INSTANCE_NAME="dpg-local"
INSTANCE_ENV="development"
API_DOMAIN="http://localhost"
API_PORT="2742"
AUTH_SECRET="replace-this"
ALLOWED_ORIGINS="http://localhost:3000"
SERVED_DOMAINS="yellow_dot/student"
NETWORK_CONFIG_SOURCE="local"
NETWORK_CONFIG_LOCAL_FILE="examples/schemas/yellow_dot/network.json"
POSTGRES_USER="postgres"
POSTGRES_PASSWORD="replace-this"
POSTGRES_DB="postgresdb"
POSTGRES_HOST="127.0.0.1"
POSTGRES_PORT="5432"
DATABASE_PORT="5432"
REDIS_HOST="127.0.0.1"
REDIS_PASSWORD="replace-this"
REDIS_PORT="5555"

Run The API

Section titled “Run The API”
Terminal window
pnpm dev:api

Build And Run The API Image

Section titled “Build And Run The API Image”

The API also ships with a production Dockerfile at apps/api/Dockerfile. To run it against the Compose PostgreSQL and Redis services:

Terminal window
docker compose up -d db redis
DOCKER_NETWORK=dpg_internal pnpm docker:api

The docker:api script builds dpg-api:local, normalizes quoted values from .env for Docker, and points the API container at db:5432 and redis:6379 inside the dpg_internal network. When running the API as a container, 127.0.0.1 inside the container is not your host machine.

Useful Checks

Section titled “Useful Checks”
  • GET /
  • /api/reference
  • GET /api/v1/item/fetch
  • GET /api/v1/network/item/fetch