seahaven-ap/packages/api/docs/local-dev.md
Adam Moussa cc637e3732
feat(api): serve portal-shaped health and error envelope
Move liveness to GET /api/health { stage, sha } with a Node 24 image on 8080 so ALB probes and deploy verify do not need auth or a database ping.
2026-09-22 12:33:19 -04:00

38 lines
851 B
Markdown

# Local development
## Data plane
```bash
docker compose up -d
npm run db:migrate
npm run db:seed
npm run dev:api
```
Defaults:
- Postgres at `postgresql://seahaven:seahaven@127.0.0.1:5432/seahaven_ap`
- API at `http://127.0.0.1:8787`
- MinIO at `http://127.0.0.1:9000` (documents bucket for AP-15)
## Smoke
```bash
curl -s http://127.0.0.1:8787/api/health
curl -s http://127.0.0.1:8787/api/me
```
With `DEV_AUTH_BYPASS=true` and `NODE_ENV=development` (or `test`), `/api/me`
does not require a Bearer token. Bypass is rejected for staging, preview,
production, and any other `NODE_ENV`.
## Docs
```bash
npm run lint:api
npm run docs:preview
```
`docs:preview` runs `redocly build-docs` (CLI v2) and opens the HTML at
`/tmp/seahaven-ap-api-docs.html`. OpenAPI servers point at
`http://127.0.0.1:8787`. Use this page for the local docs view.