Skip to content

dmsLakmal/velo

Repository files navigation

Velo - Your one destination for finance.

Velo - Your one destination for finance.

Setup

npm install

Set 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-key

Use .env.example as the non-secret reference for local and hosted environment configuration.

Development

npm run dev

Open http://localhost:3000 in your browser.

Quality Commands

npm run lint
npm run typecheck
npm run test
npm run build
npm run db:seed
npm run security:audit

Security 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.md
  • doc/FRD&Project-Structure/Mongo-Backup-Restore-Runbook.md
  • doc/FRD&Project-Structure/Incident-Response-and-Rollback-Runbook.md

Optional formatting commands:

npm run format
npm run format:write

Operations

Health endpoints:

curl http://localhost:3000/api/health
curl http://localhost:3000/api/ready

Internal database health check:

curl -H "x-admin-key: $ADMIN_API_KEY" http://localhost:3000/api/internal/db-health

Runbooks live in doc/Deployment-Runbook.md, doc/Observability-Runbook.md, doc/Backup-Restore-Runbook.md, and doc/Incident-Response-Runbook.md.

About

Velo is a finance workspace for users who need account-level visibility across multiple currencies, income, expenses, transfers, loan balances, repayments, reports, and remembered recurring items.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages