Clone and run locally

This guide takes you from a fresh clone to a running FastStaq app on Windows, macOS, or Linux.

Prerequisites

Make sure you have completed System requirements and have repository access. You need Git, Node.js 20+, pnpm 8+, and PostgreSQL + Redis available (locally or via Docker).

Step 1: Clone and install

Use the command set for your operating system. The repository URL is shown on your /dashboard/purchase page.

Windows (PowerShell):

git clone <your-repo-url>
cd faststaq
pnpm install

macOS / Linux (Terminal):

git clone <your-repo-url>
cd faststaq
pnpm install

Step 2: Set up environment files

FastStaq reads configuration from .env files in server/ and client/. Copy the provided examples and fill in values:

cp server/env.example server/.env
cp client/env.example client/.env

There is also a guided helper: run pnpm setup to scaffold your environment interactively. For a field-by-field explanation, see Environment variables reference.

Step 3: Start PostgreSQL and Redis

If you are using the bundled Docker Compose services, start them first. Otherwise make sure your local or hosted PostgreSQL and Redis are reachable and that DATABASE_URL and the Redis settings point at them. See Configure database and Redis.

Step 4: Run database migrations

Apply the schema with Prisma:

pnpm --filter @faststaq/server db:migrate:deploy

For local development you can also use pnpm --filter @faststaq/server db:migrate to create and apply migrations.

Step 5: Start the dev servers

From the repository root:

pnpm dev

This runs the client, the API, the shared package watcher, and the background worker together. By default the app is at http://localhost:3000 and the API at http://localhost:4000.

Step 6: Create your first admin

Bootstrap an admin so you can reach /admin. See First run and create an admin.

Next step

Get oriented with the Project structure overview.

Still need help?

If a step fails, check Troubleshooting common issues or open a ticket.