Getting Started

This guide takes you from a fresh clone to all three apps running locally. Every external integration is a guarded extension point — with a key absent it no-ops and logs, so the project builds and runs with zero secrets.

Prefer the big picture first? Skim Architecture and the Tech Stack, then come back here to run it.

Prerequisites

Prop

Type

Setup

Install dependencies

bun install

This installs every workspace: apps/web, apps/cms, docs, and the shared packages/*.

Create your environment files

Copy the templates and fill in whatever keys you have.

cp .env.example apps/web/.env.local
cp apps/cms/.env.example apps/cms/.env.local

While keys are incomplete, keep SKIP_ENV_VALIDATION=1 in apps/web/.env.local to bypass build-time env validation. See Environment Variables for the full canonical list.

Run the app you need

# Customer site — http://localhost:3000
bun run dev --filter=@rgss/web

# Admin portal (admin.theroyalglow.in)
bun run dev --filter=@rgss/admin

# Payload CMS admin
bun run dev --filter=@rgss/cms

# This documentation site — http://localhost:3003
bun run dev --filter=@rgss/docs

Verify the quality gates

bun run typecheck     # tsc --noEmit across all packages
bun run lint          # Biome
bun run test:unit     # Vitest unit + property-based tests
bun run build         # turbo build (all apps)

All of these pass with no environment keys configured.

Repository layout

db — Drizzle schema + Neon client + queries

business — pure business logic (no I/O)

types — shared Zod schemas + TS types

errors — AppError + error-code registry

logger — structured JSON logger

Next up: read Conventions for the coding standards every change is expected to follow, then the Git Workflow for how branches flow dev → test → pprd → prod.

Open Report an issue

Was this page helpful?

Getting Started

On this page