Velo - Your one destination for finance.
npm installSet required keys directly in .env.local for local development.
Required keys:
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=replace-with-long-random-secret
GOOGLE_CLIENT_ID=replace-google-client-id
GOOGLE_CLIENT_SECRET=replace-google-client-secret
MONGODB_URI=mongodb://127.0.0.1:27017/velo
MONGODB_DB=velo
MONGODB_SERVER_SELECTION_TIMEOUT_MS=5000
ADMIN_API_KEY=replace-internal-admin-keyUse .env.example as the non-secret reference for local and hosted
environment configuration.
npm run devOpen http://localhost:3000 in your browser.
npm run lint
npm run typecheck
npm run test
npm run build
npm run db:seed
npm run security:auditSecurity checklist for hardening phase is documented in
doc/FRD&Project-Structure/Security-Checklist.md.
Deployment and post-launch operations docs:
doc/FRD&Project-Structure/Deployment-and-Observability-Guide.mddoc/FRD&Project-Structure/Mongo-Backup-Restore-Runbook.mddoc/FRD&Project-Structure/Incident-Response-and-Rollback-Runbook.md
Optional formatting commands:
npm run format
npm run format:writeHealth endpoints:
curl http://localhost:3000/api/health
curl http://localhost:3000/api/readyInternal database health check:
curl -H "x-admin-key: $ADMIN_API_KEY" http://localhost:3000/api/internal/db-healthRunbooks live in doc/Deployment-Runbook.md,
doc/Observability-Runbook.md, doc/Backup-Restore-Runbook.md, and
doc/Incident-Response-Runbook.md.