Quick Start

Requirements

• Node.js 22+
• Docker & Docker Compose (optional, for local database)
• npm

Installation

1. Install Dependencies

# In project root
npm ci

2. Configure Environment Variables

cp .env.example .env

Edit .env in the root directory and fill in the required values. See Environment Variables.

3. Start Database and Cache

Start locally with Docker:

cd docker/dev
cp .env.example .env
# Edit .env to configure database and cache
docker compose up -d

Or use managed services (skip Docker):

Just fill the connection strings in .env for POSTGRES_CONNECTION_STRING and VALKEY_CONNECTION_STRING.

4. Run Database Migration

npm run db:migrate

5. Start Dev Servers

# Start backend (terminal 1)
npm run dev:api

# Start frontend (terminal 2)
npm run dev:console

# Start website (terminal 3, optional)
npm run dev:website

6. Create Admin

# Register an account first, then set as admin
npm run owner:set your@email.com

Access URLs