Skip to main content

Local Development

This page helps you run Nova locally with the least friction.

Prerequisites​

  • Node.js 22+
  • Docker + Docker Compose

Start everything​

docker compose up -d

Default URLs:

  • API: http://localhost:3000/v1
  • Dashboard: http://localhost:3002
  • Swagger (if enabled): http://localhost:3000/api/docs

Useful root commands​

npm start
npm run start:core
npm run start:mailpit
npm run start:mailcow
  • start:core: api + dashboard + mongo + redis
  • start:mailpit: adds local SMTP capture
  • start:mailcow: validates Mailcow env and starts Mailcow-oriented stack

API and dashboard separately​

API:

cd api
cp .env.example .env
npm install
npm run start:dev

Dashboard:

cd dashboard
cp .env.example .env.local
npm install
npm run dev