spree-project
Installation
SKILL.md
Spree Commerce Project (Spree 6)
Spree is a headless commerce engine: a Rails app (the spree gems) that serves the Store, Admin and Seller REST APIs, plus TypeScript apps you own (a React admin dashboard and a Next.js storefront). Customization happens around the engine — configuration, hooks, events, providers — not by forking it.
Coming from Spree 5.x? Read the
spree-upgrade-5-to-6skill first — cart/order split, no state machines, React dashboard, API v2 andspree_adminremoved.
Detect the project flavor FIRST — it changes every command
| Signal | Flavor | How commands run |
|---|---|---|
server/Gemfile (or legacy backend/Gemfile) + docker-compose.yml + package.json with @spree/cli |
create-spree-app project | spree <cmd> — the CLI routes into the Docker web container |
Rails app at the repo root (config/application.rb, Gemfile with spree gems), no server/ |
classic Rails app | Native from the app root: bin/rails …, bundle exec rake … |
If spree isn't on PATH, use npx spree … / pnpm exec spree …. The CLI accepts both server/ and the older backend/ directory name.