packages/create-spree-app/README.md
Scaffold a new Spree Commerce project with a single command — a full Rails backend (the Spree API) running via Docker, an optional Next.js storefront, the React Dashboard behind --react-dashboard, and the spree CLI for day-to-day work. Setup completes automatically: image pulled, database seeded, API keys configured.
npx create-spree-app my-store
| Flag | Description |
|---|---|
--react-dashboard | Include the React Dashboard (Developer Preview — also available later via spree add dashboard) |
--no-storefront | Skip Next.js storefront setup |
--no-sample-data | Skip loading sample products |
--no-start | Don't start Docker services (the first dev run completes setup instead) |
--port <number> | Port for the Spree backend (default: 3000) |
--use-npm / --use-yarn / --use-pnpm | Package manager (auto-detected from how you run the command) |
The full guide — generated project structure, customization, deployment — lives on the docs site:
Just evaluating Spree? Skip self-hosting and use a hosted sandbox.
MIT