Getting Started

Last updated

Source file

docs/foundations/README.md

This 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.

Start here when you need to choose the right template, understand the generated file structure, configure the starter environment, and verify that the generated routes behave the way the scaffold promises.

Recommended read path

  1. Prerequisites for supported local setup and template choice.
  2. Installation for the scaffold workflow and common CLI variants.
  3. Environment and Services for .env.local, service ownership, and platform config ownership.
  4. Project Structure for generated settings, mounts, assets, and migrations.
  5. Validate Your Starter for the first-run route checks.
  6. The bw CLI for adding, upgrading, and diagnosing modules after scaffold.

Platform app vs standalone site

BrightWeb Stack scaffolds two different application shapes:

  • platform: authenticated BrightWeb app shell with shared runtime wiring and optional business modules
  • site: standalone Next.js App Router site starter with a local UI layer

Do not assume the site template includes platform auth, shared shell behavior, or module-backed product wiring. That distinction drives which parts of the rest of the docs apply to your project.

Pages in this section