Shipflash logoDocs

Set Up Locally

Start with the pinned toolchain, a Supabase project, and the required app environment values.

On this page
  1. 1

    Install with the pinned package manager

    The repo expects Node 24 from .nvmrc and the pnpm version pinned in package.json.

    text
    pnpm install --frozen-lockfile
  2. 2

    Create the local environment file

    Copy the template and fill the core required values first.

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

    Start the app

    Use the normal Next.js development server.

    text
    pnpm run dev
  4. 4

    Run the baseline checks

    Use this before shipping a normal change.

    text
    pnpm run quality

Required first-pass values

ValuePurpose
NEXT_PUBLIC_SUPABASE_URLSupabase project URL used by the app.
NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEYPublic Supabase browser key.
SUPABASE_SECRET_KEYServer-only Supabase key for trusted operations.
APP_URLPrimary canonical app URL for links, SEO, and redirects (NEXT_PUBLIC_SITE_URL is legacy fallback).
NEXT_PUBLIC_SITE_NAMEDefault public product name.
NEXT_PUBLIC_SUPPORT_EMAILPublic support contact used in site copy and emails.
SUPER_ADMIN_EMAILInitial owner email used by admin and notification defaults.