Prerequisite installs

Install the following before setting up your generated project.

Code editor

We recommend Visual Studio Code — it has great TypeScript support, integrated terminal, and a rich extension ecosystem.

Node.js

Your project requires Node.js 20+ (LTS recommended). Install it via nvm:

• macOS / Linux: nvm
• Windows: nvm-windows

Then run:

nvm install lts
nvm use lts

pnpm

The project uses pnpm as its package manager. The easiest way to install it is via Node.js corepack:

corepack enable
corepack prepare pnpm@latest --activate

PostgreSQL

Your project uses PostgreSQL as its database. You can use pgAdmin as a free GUI to manage your databases. Install PostgreSQL using one of the following:

• macOS: Postgres.app
• Windows: PostgreSQL Installer
• Linux: PostgreSQL Downloads

Redis (optional)

Redis is used for caching (auth sessions, members, organizations, subscriptions). It's entirely optional — the app works without it, falling back to direct database queries. Adding Redis improves performance under load. You can use Redis Insight as a free GUI to browse and manage your data.

• macOS: Redis via Homebrew
• Windows: Memurai or Redis via WSL
• Linux: Redis Downloads

Docker (optional)

Docker is only needed if your project uses file uploads (MinIO as local S3 storage) or multi-domain organization mode (Caddy reverse proxy). If neither applies, you can skip this.

• Docker Desktop (macOS / Windows / Linux)

Mobile development (optional)

Only needed if your project includes the mobile app package (Expo + React Native).

You need simulators installed to run the app locally:

• iOS: macOS with Xcode 16+. After installing, open Xcode and go to Settings → Platforms to download an iOS Simulator runtime. Then open the Simulator app (or run open -a Simulator) to verify it works.
• Android: Android Studio with Android SDK. Open Android Studio → Virtual Device Manager and create an emulator with a recent Android version. Make sure you can launch the emulator before proceeding.