Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

2.4 KB
Raw Blame

create-spree-app

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 Admin Dashboard and an optional marketplace seller panel, and the spree CLI for day-to-day work. Setup completes automatically: image pulled, database seeded, API keys configured.

Requirements

npm ERR! cb.apply is not a function means your npm is too old for your Node.js version. Reinstall a current Node.js (it ships with a matching npm) and run the command again. See Troubleshooting.

Quick Start

npx create-spree-app my-store
Flag Description
--no-dashboard Skip the Admin Dashboard app — the API still serves the built-in one at /dashboard (add your own copy later via spree add dashboard)
--seller-dashboard Include the marketplace seller panel without asking
--no-seller-dashboard Skip the marketplace seller panel (also available later via spree add seller-dashboard)
--no-storefront Skip Next.js storefront setup
--agent-skills Install the Spree agent skills without asking
--no-agent-skills Skip installing the Spree agent skills (also available later via spree add ai)
--docs-mcp Connect coding agents to the Spree docs MCP server without asking
--no-docs-mcp Skip connecting coding agents to the Spree docs MCP server (also available later via spree add ai)
--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)

Documentation

The full guide — generated project structure, customization, deployment — lives on the docs site:

Just evaluating Spree? Skip self-hosting and use a hosted sandbox.

License

MIT