Shipflash logoDocs

Getting Started

Use this sequence to move from a fresh checkout to a verified local app with the first admin path understood.

On this page
  1. 1

    Prepare the toolchain

    Use the Node and pnpm versions pinned by the app repository. Install dependencies before editing configuration.

    text
    pnpm install --frozen-lockfile
  2. 2

    Create environment values

    Copy the env template, then fill Supabase, site, support, admin, billing, email, and cron values in that order.

    text
    cp .env.example .env.local
  3. 3

    Start locally

    Run the Next.js dev server and confirm the marketing home, auth pages, dashboard redirect, docs route, and health endpoint load.

    text
    pnpm run dev
  4. 4

    Create the first admin

    Use the configured SUPER_ADMIN_EMAIL, Supabase Auth, and dashboard role checks to confirm admin access before provider setup.

  5. 5

    Run diagnostic checks

    Run the doctor script to validate environment variables, configuration placeholders, billing catalogs, and live database connectivity.

    text
    pnpm run doctor
  6. 6

    Verify setup

    Run quality checks, then test auth, billing setup, notification settings, cron auth, and a representative content page.

    text
    pnpm run quality

First verification pass

AreaVerify
AuthSign up, sign in, sign out, and open /account.
AdminConfirm the first super admin reaches /admin/security and /admin/team.
BillingOpen /billing/setup before test checkout.
EmailConfirm sender settings and notification templates before sending.
CronCall scheduled routes with Authorization: Bearer <CRON_SECRET>.
QualityRun pnpm run quality before treating setup as stable.