Getting Started

Prerequisites

Node.js 20+
Docker and Docker Compose
(Optional) An SMTP server for email code auth — Mailpit works well for local dev

# Clone and install
git clone <your-repo-url> my-app
cd my-app
npm install

# Create your env file
cp .env.example .env

Edit .env and set JWT_SECRET to a random string. The rest of the defaults work for local development.

# Start Postgres
docker compose up postgres -d

# Run database migrations
npm run migrate

# Start the app (Vite + Hapi concurrently)
npm run dev

The frontend is at http://localhost:5173. The Vite dev server proxies /api requests to Hapi on port 3001 automatically.

cp .env.example .env
docker compose up --build -d
docker compose exec app node server/migrate.js

The app is at http://localhost:3001. See Deployment for production setups.

Command	Description
`npm run dev`	Start Vite + Hapi concurrently
`npm run dev:client`	Vite dev server only
`npm run dev:server`	Hapi with nodemon only
`npm run build`	Build frontend for production
`npm run start`	Start Hapi in production mode (serves built frontend)
`npm run migrate`	Run database migrations (local dev)

For testing email code auth locally, run Mailpit:

docker run -d -p 1025:1025 -p 8025:8025 axllent/mailpit

The default SMTP settings in .env.example point to localhost:1025. View captured emails at http://localhost:8025.