Operations
This document covers the current operational commands and checks.
Local development
npm ci
docker compose -f docker-compose.dev.yml up -d
npm run db:migrate:deploy
npm run db:seed
npm run dev
Local development defaults to http://localhost:3001 unless you override DEV_PORT.
Validation
npm run lint
npm run typecheck
npm run build
npm run test
Smoke tests
The repo includes smoke tests for the live runtime dependencies:
npm run test:db
npm run test:minio
npm run test:health
Notes:
test:dbchecks the configured PostgreSQL connection.test:miniochecks the configured MinIO connection and bucket addressability.test:healthchecks the combined runtime health status for PostgreSQL and MinIO.- You can point the smoke tests at alternate targets with
SMOKE_*overrides such asSMOKE_DATABASE_URLorSMOKE_MINIO_ENDPOINT.
Production Docker
docker compose up --build -d
docker compose ps
docker compose logs -f app
Runtime startup order
The production app container:
- applies migrations
- creates MinIO buckets
- runs idempotent bootstrap seed data
- starts the Next.js server
Health
Use:
curl http://127.0.0.1:3000/api/health
Expected result:
db: okminio: ok
Useful scripts
npm run db:generatenpm run db:migrate:deploynpm run db:seednpm run db:seed:runtimenpm run storage:init
Integration operations
- create webhook from
/integrations - copy the one-time webhook URL immediately
- revoke and recreate if a secret leaks