Local Setup

Prerequisites

• The Node version pinned in the repository’s .node-version
• The pnpm version pinned in the root package.json packageManager field
• Supabase CLI (for migrations)
• Clerk, Stripe, and Resend dev credentials

Environment Configuration

1. Run pnpm setup:local from the repository root. It installs app and docs dependencies with frozen lockfiles and creates .env.local from .env.example only when the local file is missing.
2. Configure .env.local with a local Supabase URL and local keys, plus non-production Clerk, Stripe, and other provider credentials as needed.
3. Local auth bypass is enabled by default by pnpm dev. To test real auth, set DEV_AUTH_BYPASS, NEXT_PUBLIC_DEV_AUTH_BYPASS, ECLIPSE_LOCAL_AUTH_BYPASS, and ECLIPSE_LOCAL_PROXY_AUTH_BYPASS to false in your shell.

Production Safety

Never enable local auth bypass against Production. The dev data-plane guard blocks remote Supabase unless explicitly approved for an isolated non-production project. Setup preserves existing environment files.

Install & Run

pnpm setup:local
pnpm dev

The everyday commands work in PowerShell, Bash, and zsh. The app listens on http://127.0.0.1:3001. Use pnpm typecheck and pnpm test:isolated while developing, and run pnpm verify before release.

pnpm build:docs reuses unchanged, verified docs output. Add --force to rebuild.

Resend CLI

Install the official CLI and use the repo wrapper so commands automatically read RESEND_API_KEY from local env files:

curl -fsSL https://resend.com/install.sh | bash
pnpm resend:whoami
pnpm resend:doctor

Pass through any other command with:

pnpm resend -- <command>

Examples:

pnpm resend -- domains list
pnpm resend -- webhooks list

Preview the repository-owned React Email templates locally:

pnpm email:dev

Before release, verify that every template renders as complete HTML and plain text without unresolved values:

pnpm email:check

Database Setup

supabase start

Configure .env.local with the local keys reported by Supabase. Follow docs/guides/database.md in the repository for candidate migration checks. Local setup does not push migrations to linked projects. Staging and Production schema changes require a separate release procedure and an explicitly identified target.

References

• .env.example
• docs/setup/QUICK_START.md (canonical local setup)
• docs/guides/database.md
• docs/guides/release.md