BrightWeb Stack Docs

Last updated

Source file

docs/README.md

BrightWeb Stack is the shared foundation for building authenticated platform apps and standalone sites with a common scaffold, shared packages, and durable module boundaries. The public docs are optimized for external users starting from create-bw-app.

The markdown in this folder is the source of truth for both the repository docs and the apps/dev-docs site.

Public docs sections

  • Getting Started: the external-first onboarding path from prerequisites through starter validation
  • Modules: what the platform base includes and how Organizations, CRM, Marketing, and Projects extend that baseline
  • Recipes: practical how-to pages for validating and extending thin package mounts

How to read the docs

If you are new to the stack, start in this order:

  1. Prerequisites
  2. Installation
  3. Environment and Services
  4. Project Structure
  5. Validate Your Starter
  6. Modules
  7. Recipes

Maintainer-only notes, architecture decisions, and operational runbooks live in the repo under docs/internal/. They are intentionally excluded from the public docs app navigation.

Assumed background

The public docs assume working familiarity with:

  • HTML
  • CSS
  • JavaScript or TypeScript
  • React
  • Next.js

If you are working with module-backed platform apps, basic Supabase familiarity is also useful.