Getting Started

Prerequisites

Install Node.js

Install and set Node.js 22 as default using nvm:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.4/install.sh | bash
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

nvm install 22 && nvm alias default 22

Install pnpm

If you don't have pnpm installed, install it using one of the following methods:

Using npm:

npm install -g pnpm@10.28.0

Using corepack (recommended):

corepack enable
corepack prepare pnpm@10.28.0 --activate

Using standalone script:

curl -fsSL https://get.pnpm.io/install.sh | sh -

Verify your installation:

pnpm --version

Quick Start

1. Clone and Setup

git clone <repository-url>
cd <project-name>
pnpm run setup

Setup runs install, git hooks, security tools, and database. See the root README in the repository for the full script reference. Together this brings the monorepo to a working dev environment with security tooling and the database.

2. Environment variables

• copy fastify/.env-sample over to fastify/.env and update the values

3. Explore the Running Apps

pnpm dev

This will start the main applications and the packages in watch mode.

• API: http://localhost:3001 (GET /health, /reference for docs)
• Next: http://localhost:3000 (Next.js app)

To run the docs site: pnpm --filter @repo/docu dev (e.g. http://localhost:3002).

4. Understand the Structure

Apps: apps/fastify/ (Fastify backend), apps/next/ (Next.js frontend), apps/docu/ (documentation)

Packages: core/ (generated API client + types), react/ (React Query hooks), ui/ (components), sentry/ (Sentry integration), utils/ (utilities)

Next Steps

Continue your AI-assisted development setup:

• Installation - Environment variables and optional database setup
• AI Workflow - Recommended development workflow
• Cursor Setup - Configure your IDE

Understand Core Concepts:

• Architecture - Monorepo structure, API architecture, and OpenAPI generation
• Architecture - Deep technical details and design decisions

Optional Setup:

For database features, you'll need PostgreSQL. See Installation.