API

Prerequisites

• Node.js 22+
• Docker

Steps

1. Install dependencies

cd apps/api
npm install

2. Start local services

Spin up PostgreSQL (port 5434) and Redis (port 6379):

docker compose up -d

3. Configure environment

cp .env.dist .env

Edit .env with your local values. The defaults work out of the box for Docker Compose.

4. Run migrations and start the dev server

npm run dev

The API is now available at http://localhost:3001.

5. Optional: create an admin user with the CLI

The API includes a CLI for one-off tasks such as creating the first user. From apps/api, run:

npm run rawstack user:create

This command creates a user with an email and password and can also be used to create an admin user.

Find out more about the API by reading the in-depth deep dive.