Skip to main content

Developer Portal Service — Local Dev Setup

Version: 1.0 Status: Draft Owner: Product + Developer Relations (DevRel) Last Updated: 2026-04-20

1. Intent​

Enable a contributor to run the Developer Portal stack locally with docker compose up, including a fake auth-service, fake sms-orchestrator, and a Redis used for Verify session state.

2. Prerequisites​

  • Node 22 LTS, pnpm 9. TBD
  • Docker Desktop / Colima. TBD
  • mkcert for local TLS. TBD

3. Quickstart​

git clone <repo>
cd services/developer-portal-service
cp .env.example .env
docker compose up -d  # Postgres, Redis, fake auth, fake orchestrator, MinIO
pnpm install
pnpm dev:docs        # Next.js dev on :3000
pnpm dev:api         # NestJS dev on :3010
pnpm dev:sandbox     # Fastify dev on :3020

4. Seed Data​

  • TBD (seed developer accounts, sample SDK release rows, sample Verify templates)

5. Common Commands​

  • pnpm test — Vitest unit suite. TBD
  • pnpm test:integration — runs against the docker-compose stack. TBD
  • pnpm openapi:lint — Spectral lint of openapi/v1.yaml. TBD

6. Env Vars​

  • DEVPORTAL_AUTH_SERVICE_URL — TBD
  • DEVPORTAL_ORCH_URL — TBD
  • DEVPORTAL_REDIS_URL — TBD
  • DEVPORTAL_PG_URL — TBD
  • DEVPORTAL_VERIFY_PEPPER — TBD (dev-only value)

7. Troubleshooting​

  • TBD