Getting started

Start with a working foundation.

Get a working Northstack project up and running in minutes, with auth, billing, organizations, roles and an admin panel already wired.

Install dependencies

Turn on Corepack once (it ships with Node.js 22.9 and newer), then install each app with the Yarn version the repository pins.

corepack enable
cd back-end && yarn install && cd ..
cd dashboard && yarn install && cd ..
cd website && yarn install && cd ..

Copy each app's environment template. The defaults run everything on your machine: the API on 8000, the dashboard on 3031 and this site on 3030.

cp back-end/.env.example back-end/.env
cp dashboard/.env.example dashboard/.env
cp website/.env.example website/.env

Use the environment template for your deployment, and set your own JWT_SECRET in back-end/.env before anyone else can reach the API.

Seed the sample data once, then start each app in its own terminal and open http://localhost:3030.

cd back-end && yarn seed && yarn dev
cd dashboard && yarn dev
cd website && yarn dev

Prefer Docker? From the repository's root, docker compose up --build builds and starts all three apps with the sample data.