Quick Start#

Requirements#

  • Node.js 24.16.0

Setup#

Install Dependencies#

bashnpm ci

Configure Environment Variables#

bashcp .env.example .env

Edit .env with your configuration. See Environment Variables.

Generate strong random secrets like JWT_SECRET and API_KEY with openssl rand -hex 32 — don't ship the placeholders.

PostgreSQL connection string can be obtained from: Supabase, Neon, Railway

Run Database Migration#

bashnpm run db:migrate

Start Development Server#

bashnpm run dev

Create Admin User#

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

Access URL#

ServiceURL
Apphttp://localhost:3000

Common Commands#

CommandDescription
npm run devStart dev server
npm run buildBuild for production
npm startStart production server
npm run db:migrateRun database migrations
npm run owner:set <email>Set admin
npm run owner:remove <email>Remove admin
npm run owner:listList all admins
PreviousOverviewNextProject Structure