Headless Commerce
Spree is a modular, API-first headless e-commerce platform that consists of several APIs.
Modern and lightweight REST API based on JSON API schema
Designed for building Storefronts and mobile apps
JavaScript / TypeScript SDK available
Next.js Commerce integration available 🎉
Vue Storefront integration will be available soon 🚀
Platform API (Developer Preview)
OAuth 2.0 authentication
designed for building application to application integration
permission sets based access to resources
access any resource on the Spree platform and perform any action
We're working hard to deliver webhooks in the Spree v4.4!
Spree allows limitless storefront customization.
You can build your own storefront from scratch using our SDK which takes care of all heavy lifting tasks, or you can use Next.js Commerce or Vue Storefront.
Spree is divided into several modules / gems which you can install independently.
Spree Starter comes with all modules pre-installed for you convenience!
Spree module | Description |
spree | Data models, Services and APIs |
spree_backend | Admin Panel UI |
spree_sample | Sample seed data |
spree_emails | Transactional emails, eg. order confirmation |
There are many other packages adding more features called Extensions.
To change which Spree gems you would like to install you will need to modify your project Gemfile.
gem 'spree'
gem 'spree'gem 'spree_backend'
After changing the Gemfile you need to run
bundle install
or if using Spree Starter:
bundle installdocker-compose build
We recommend you go over Internals section to learn more about how Spree works under the hood.
