- Join our Slack at slack.spreecommerce.org
- Start a new project or get tech support
- Success Stories
- Maintenance Policy
Spree is a complete open source e-commerce solution built with Ruby on Rails. It was originally developed by Sean Schofield and is now maintained by Spark Solutions. We're open to contributions and accepting new Core Team members.
Spree consists of several different gems, each of which are maintained in a single repository and documented in a single set of online documentation.
- spree_frontend (default Rails customer frontend)
- spree_backend (Admin Panel)
- spree_cmd (Command-line tools)
- spree_core (Models, Services & Mailers, the basic components of Spree that it can't run without)
- spree_sample (Sample data)
You don't need to install all of the components. Only the Core is mandatory.
If you want to run the demo on your local machine, you can use our docker image. It will download and run sample Spree application on http://localhost:3000
docker run --rm -it -p 3000:3000 spreecommerce/spree:3.6.4
Admin Panel credentials - login:
email@example.com / password:
Add Spree gems to your
gem 'spree', '~> 3.7.0' gem 'spree_auth_devise', '~> 3.5' gem 'spree_gateway', '~> 3.4'
Spree 3.7 introduces REST API v2 and new customization system called Dependencies - we recommend starting with this version as it will be an easy upgrade to Spree 4.0.
gem 'spree', '~> 3.5.0' gem 'spree_auth_devise', '~> 3.5' gem 'spree_gateway', '~> 3.4'
gem 'spree', '~> 3.2.7' gem 'spree_auth_devise', '~> 3.5' gem 'spree_gateway', '~> 3.4'
Use the install generators to set up Spree:
rails g spree:install --user_class=Spree::User rails g spree:auth:install rails g spree_gateway:install
Alternatively, if you want to use the bleeding edge version of Spree, add this to your Gemfile:
gem 'spree', github: 'spree/spree' gem 'spree_auth_devise', github: 'spree/spree_auth_devise' gem 'spree_gateway', github: 'spree/spree_gateway'
Note: The master branch is not guaranteed to ever be in a fully functioning state. It is unwise to use this branch in a production system you care deeply about.
By default, the installation generator (
rails g spree:install) will run
migrations as well as adding seed and sample data and will copy frontend views
for easy customization (if spree_frontend available). This can be disabled using
rails g spree:install --migrate=false --sample=false --seed=false --copy_views=false
You can always perform any of these steps later by using these commands.
bundle exec rake railties:install:migrations bundle exec rake db:migrate bundle exec rake db:seed bundle exec rake spree_sample:load
Browse Admin Interface
If you have
spree_auth_devise installed, you can generate a new admin user by running
Spree Extensions provide additional features not present in the Core system.
|Extension||Spree 3.2+ support||Description|
|spree_gateway||Community supported Spree Payment Method Gateways|
|spree_auth_devise||Provides authentication services for Spree, using the Devise gem.|
|spree_i18n||I18n translation files for Spree Commerce|
|spree-multi-domain||Multiple Spree stores on different domains - single unified backed for processing orders|
|spree_multi_currency||Provides UI to allow configuring multiple currencies in Spree|
|spree_multi_vendor||Spree Multi Vendor Marketplace extension|
|spree-mollie-gateway||Official Mollie payment gateway for Spree Commerce.|
|spree_braintree_vzero||Official Spree Braintree v.zero + PayPal extension|
|spree_address_book||Adds address book for users to Spree|
|spree_digital||A Spree extension to enable downloadable products|
|spree_social||Building block for spree social networking features (provides authentication and account linkage)|
|spree_related_products||Related products extension for Spree|
|spree_static_content||Manage static pages for Spree|
|spree-product-assembly||Adds oportunity to make bundle of products|
|spree_editor||Rich text editor for Spree with Image and File uploading in-place|
|spree_recently_viewed||Recently viewed products in Spree|
|spree_wishlist||Wishlist extension for Spree|
|spree_sitemap||Sitemap Generator for Spree|