Ruby HTML CSS JavaScript CoffeeScript Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.github Better information about contributing process Mar 15, 2017
api Run rubocop -a in core/spec Feb 13, 2018
backend Add preview product button on products edit page Mar 15, 2018
cmd Add rubocop, rubocop-rspec configs to extension template, apply ruboc… Feb 7, 2018
core Add preview product button on products edit page Mar 15, 2018
frontend configure screenshot for headless chrome Mar 8, 2018
guides Typo in guides Mar 12, 2018
lib rubocop Style/StringLiterals corrections Sep 7, 2017
sample Merge pull request #8607 from spark-solutions/fix-samples-taxons-filt… Feb 14, 2018
.codeclimate.yml Explicitly set rubocop.yml config file in codeclimate Feb 7, 2018
.editorconfig EditorConfig 150 characters per line Jan 10, 2018
.eslintignore Ignore extension template in ESLint/StyleLint Jan 10, 2018
.eslintrc Replace JSHint and CoffeeLint with ESLint Jan 10, 2018
.gitignore Added .ruby-version file for Spree developers to ease the pain of swi… Oct 6, 2017
.rubocop-disabled.yml Run rubocop -a in core/spec Feb 13, 2018
.rubocop.yml Run rubocop -a in core/spec Feb 13, 2018
.ruby-version Use ruby 2.4.2 on Circle/Travis (#8482) Nov 22, 2017
.stylelintignore Ignore extension template in ESLint/StyleLint Jan 10, 2018
.stylelintrc Added StyleLint Jan 10, 2018
.travis.yml Use ruby 2.4.2 on Circle/Travis (#8482) Nov 22, 2017 3.5.0 changelog entry/release notes starting point Oct 8, 2017 add code of conduct from contributor covenant v1.2 Jul 23, 2015
Dockerfile create dockerfile and entrypoint for docker Oct 27, 2017
Gemfile Isolate each component of Spree Mar 21, 2012 add spree_globalize, spree_analytics_trackers and spree_avatax_certfi… Mar 8, 2018
Rakefile SPREE_VERSION removed, total cleanup of gemspecs and rakefiles, spree… Feb 28, 2016
app.json use spree/spree repository instead of spark-solutions/spree Sep 4, 2017
build-ci.rb rubocop minor fixes Sep 7, 2017 Add setting bundle gemfile to test_app Feb 6, 2018
circle.yml Use newest available bundler version on Circle CI Mar 12, 2018
common_spree_dependencies.rb Add rubocop-rspec, add rubocop-disabled.yml Feb 13, 2018 create dockerfile and entrypoint for docker Oct 27, 2017 bump the year range Aug 16, 2017
spree.gemspec Proper slack url: Sep 15, 2017
spree_logo.png Old/new logo for the Spree Open Source project Jul 27, 2016

Gem Version Circle CI Code Climate codebeat Slack Status

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 developers from Spark Solutions and Vinsol. 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_api (RESTful API)
  • spree_frontend (Customer frontend)
  • spree_backend (Admin panel)
  • spree_cmd (Command-line tools)
  • spree_core (Models & Mailers, the basic components of Spree that it can't run without)
  • spree_sample (Sample data)


Try Spree with direct deployment on Heroku:


If you have want to run demo spree application on your machine, you can use our docker image with command below. It will download and run sample Spree application on http://localhost:3000

docker run --rm -it -p 3000:3000 spreecommerce/spree:latest

Getting Started

Add Spree gems to your Gemfile:

Rails 5.1

gem 'spree', '~> 3.4.4'
gem 'spree_auth_devise', '~> 3.3'
gem 'spree_gateway', '~> 3.3'

Rails 5.0

gem 'spree', '~> 3.2.7'
gem 'spree_auth_devise', '~> 3.3'
gem 'spree_gateway', '~> 3.3'

Rails 4.2

gem 'spree', '~> 3.1.12'
gem 'spree_auth_devise', '~> 3.3'
gem 'spree_gateway', '~> 3.3'

Note: If you're using fresh Rails 5.1 application, you need to run bundle update i18n before following steps below.

Run bundle install

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

Installation options

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

Bundle Issues

If you encountered any problems with bundler, please try downgrading to bundler 1.13.7 or earlier.

Browse Store


Browse Admin Interface


If you have spree_auth_devise installed, you can generate a new admin user by running rake spree_auth:admin:create.


Spree Extensions provide additional features not present in the Core system.

Extension Spree 3.1+ support Description
spree_gateway Build Status Community supported Spree Payment Method Gateways
spree_auth_devise Build Status Provides authentication services for Spree, using the Devise gem.
spree_i18n Build Status I18n translation files for Spree Commerce
spree-multi-domain Build Status Multiple Spree stores on different domains - single unified backed for processing orders
spree_multi_currency Build Status Provides UI to allow configuring multiple currencies in Spree
spree_braintree_vzero Build Status Official Spree Braintree + PayPal extension
spree_address_book Build Status Adds address book for users to Spree
spree_digital Build Status A Spree extension to enable downloadable products
spree_social Build Status Building block for spree social networking features (provides authentication and account linkage)
spree_related_products Build Status Related products extension for Spree
spree_active_shipping Build Status Spree integration for Shopify's active_shipping gem
spree_static_content Build Status Manage static pages for Spree
spree-product-assembly Build Status Adds oportunity to make bundle of products
spree_editor Build Status Rich text editor for Spree with Image and File uploading in-place
spree_recently_viewed Build Status Recently viewed products in Spree
spree_wishlist Build Status Wishlist extension for Spree
spree_sitemap Build Status Sitemap Generator for Spree
spree_volume_pricing Build Status It determines the price for a particular product variant with predefined ranges of quantities
better_spree_paypal_express Build Status This is the official Paypal Express extension for Spree.
spree_globalize Build Status Adds support for model translations (multi-language stores)
spree_avatax_certified Build Status Improve your Spree store's sales tax decision automation with Avalara AvaTax
spree_analytics_trackers Build Status Adds support for Analytics Trackers (Google Analytics & Segment)


You may notice that your Spree store runs slowly in development environment. This can be because in development each asset (css and javascript) is loaded separately. You can disable it by adding the following line to config/environments/development.rb.

config.assets.debug = false

Developing Spree

Spree is meant to be run within the context of Rails application and the source code is essentially a collection of gems. You can easily create a sandbox application inside of your cloned source directory for testing purposes.

Clone the Git repo

git clone git://
cd spree

Install the gem dependencies

bundle install


Create a sandbox Rails application for testing purposes which automatically perform all necessary database setup

bundle exec rake sandbox

Start the server

cd sandbox
rails server

Running Tests

We use CircleCI to run the tests for Spree.

You can see the build statuses at

Each gem contains its own series of tests, and for each directory, you need to do a quick one-time creation of a test application and then you can use it to run the tests. For example, to run the tests for the core project.

cd core
BUNDLE_GEMFILE=../Gemfile bundle exec rake test_app
bundle exec rspec spec

If you would like to run specs against a particular database you may specify the dummy app's database, which defaults to sqlite3.

DB=postgres bundle exec rake test_app

If you want to run specs for only a single spec file

bundle exec rspec spec/models/spree/state_spec.rb

If you want to run a particular line of spec

bundle exec rspec spec/models/spree/state_spec.rb:7

You can also enable fail fast in order to stop tests at the first failure

FAIL_FAST=true bundle exec rspec spec/models/state_spec.rb

If you want to run the simplecov code coverage report

COVERAGE=true bundle exec rspec spec

If you're working on multiple facets of Spree to test, please ensure that you have a postgres user:

createuser -s -r postgres

And also ensure that you have PhantomJS installed as well:

brew update && brew install phantomjs

To execute all the tests, you may want to run this command at the root of the Spree project to generate test applications and run specs for all the facets:



Spree is an open source project and we encourage contributions. Please review the contributing guidelines before contributing.

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:


Spree is released under the New BSD License.