Shipflash logoDocs

Buyer Journey

Follow this path to install, configure, customize, test, deploy, and upgrade the foundation without skipping operational checks.

On this page
  1. 1

    Install

    Install the pinned toolchain, copy the env template, connect Supabase, and boot the app.

    • /docs/getting-started
    • /docs/local-setup
    • /docs/supabase-guide
    text
    pnpm install --frozen-lockfile && pnpm run dev
  2. 2

    Configure

    Set identity, provider, email, security, and operational values before enabling customer flows.

    • /docs/environment-variables
    • /docs/configuration-guide
    • /docs/payments-guide
  3. 3

    Customize

    Choose an owning feature, preserve its server and data boundaries, and use a focused recipe.

    • /docs/product-modules
    • /docs/customization-recipes
    • /docs/ai-agent-guide
  4. 4

    Test

    Run the targeted test slice, structural contracts, and representative browser journeys.

    • /docs/testing-guide
    • /docs/production-checklists
    text
    pnpm run test:features && pnpm run quality
  5. 5

    Deploy

    Apply migrations, configure production providers and scheduled work, then complete the launch smoke test.

    • /docs/deployment-guide
    • /docs/production-launch
    • /docs/background-jobs
  6. 6

    Upgrade

    Review behavior, schema, env, provider, and breaking changes before merging an update into a customized app.

    • /docs/updates-and-upgrades
    • /docs/database-migrations
    • /docs/documentation-coverage
Implementation reference4 areas

These Product code locations explain how the documented behavior is implemented. Expand them when you are ready to customize or maintain this area.

Boot and configuration

Central config and Supabase factories fail early when required values are absent.

  • src/lib/config.ts
  • src/lib/supabase/server.ts

Provider readiness

Billing setup reports missing provider credentials, catalog entries, and webhook readiness before checkout.

  • src/features/billing/server/runtime/readiness.ts

Deployment health

The health route and protected jobs provide concrete launch checks.

  • src/app/api/health/ready/route.ts
  • src/lib/security/secrets/cron-secret.ts

Upgrade boundaries

Migration history and generated types expose durable data-contract changes.

  • supabase/migrations/20260426000000_init.sql
  • src/lib/supabase/types.ts

Reference paths are relative to the Shipflash-Product checkout.

Journey exit criteria

  • Local boot, auth, and first-admin access are verified.
  • Only intentional providers and product modules are enabled.
  • Customization includes targeted tests and updated documentation.
  • Production webhooks, cron routes, email, billing, and health checks are verified.
  • Upgrade work includes migration, env, generated type, and source-evidence review.