Prerequisites
Use this page before running create-bw-app. It covers the supported local setup, how to choose between the two public templates, and which external services the starter expects.
Local toolchain
The public scaffold package currently declares node >=20.
For the public path, plan on having:
- Node.js 20 or newer
- a package manager for the generated app; the public examples use
pnpmornpm - a terminal where you can run the scaffold and the generated Next.js scripts
- Git if you want to commit the generated project immediately
BrightWeb does not require a private workspace checkout for the public scaffold flow. The external-first path starts from pnpm dlx create-bw-app or npm create bw-app@latest.
Choose the right template
| Template | Choose it when | What you get on day 1 | Services required to fully validate the starter |
|---|---|---|---|
platform | You need shared auth, app-shell wiring, and optional BrightWeb business modules such as CRM, Marketing, or Projects. | A thin authenticated shell with settings, .env.local, migrations, and direct package mounts for the selected modules. | Supabase and Resend. Optional modules also need the matching database schema available in the target client database. |
site | You need a standalone marketing or editorial site without the heavier platform runtime. | A thin Next.js App Router shell with config/site.ts, theme tokens, and no default feature page. | None for the shell itself. |
Service expectations by template
Site
- The site shell builds without a generated
.env.local. - Identity and theme settings live in
config/site.tsandapp/globals.css; page UI belongs in a package. - Add third-party services only when your own site requirements need them.
Platform
- The platform starter writes
.env.localfor service values and generated config files for starter brand and module state. - The scaffold can build before every service value is filled in, but package-mounted runtime routes require their real auth and service configuration.
- Auth and module playground routes become genuinely useful only after the external services and database schema are configured.
Module selection expectations
crm,marketing,projects, andadmincontrol package wiring, generated runtime config, and available package mounts.- The platform database baseline always includes
Core + Admin. Selectingadmincontrols whether the Admin package mount and wiring are scaffolded. - Projects build on the Core + Admin + Organizations database baseline without requiring CRM.
- Marketing resolves Core + Admin + Organizations + CRM because its consent and audience model targets CRM contacts.
Recommended first path
- Choose
siteif you want the fastest path to a public-facing Next.js starter without platform auth or module-backed workflows. - Choose
platformif you need the BrightWeb shell, auth layer, or module-backed product work. - Read Installation next, then move to Environment and Services if you picked
platform.
Related docs
PreviousGetting StartedThis section is the external-first onboarding path for `create-bw-app`. Use it to get from local prerequisites to a validated thin app with settings and package-owned mounts.NextInstallation`create-bw-app` is the public BrightWeb scaffold for starting either a platform app or a standalone site.