- Join our Slack at slack.spreecommerce.org
- Contact us to start a new project or get tech support
- DEMO of the new Spree UX introduced in Spree 4.1
- 9 good reasons to upgrade to Spree 4.1 or use it for a new project
- Success Stories
- Integrations
- Extensions
- Documentation
- Roadmap
- Maintenance Policy
Spree is a complete open source e-commerce solution built with Ruby on Rails. It was started by Sean Schofield and is now developed by Spark Solutions. We're open to contributions.
Spree consists of several different gems (modules), each of which are maintained in a single repository and documented in a single set of online documentation.
- spree_api (REST API v2 with JavaScript / TypeScript SDK and REST API v1)
- spree_graphql (GraphQL API - coming soon)
- spree_frontend (mobile-first, blazing fast and customizable storefront)
- spree_backend (feature rich Admin Panel)
- spree_cmd (command-line tools for developers)
- spree_core (models, services & mailers, the basic components of Spree)
- spree_sample (sample data for demo purposes)
Go to: https://demo.spreecommerce.org/ Explore demo features: https://spreecommerce.org/spree-commerce-demo-explainer/
Or fire up your own demo on Heroku:
Admin panel credentials for your own Heroku demo:
- login:
[email protected] - password:
spree123
If you're starting a new application from scrach run:
rails new my_store
cd my_storeYou can add Spree to your existing Rails application as well.
gem 'spree', '~> 4.1'
gem 'spree_auth_devise', '~> 4.1'
gem 'spree_gateway', '~> 3.7'gem 'spree', '~> 3.7.0'
gem 'spree_auth_devise', '~> 3.5'
gem 'spree_gateway', '~> 3.4'To see what rails version are you using run this command:
rails -vOlder rails versions are also supported: Rails 5.1, Rails 5.0, Rails 4.2
bundle installNote: if you run into Bundler could not find compatible versions for gem "sprockets": error message, please run
bundle updaterails g spree:install --user_class=Spree::User
rails g spree:auth:install
rails g spree_gateway:installBy default, the installation generator (rails g spree:install) will run
migrations as well as adding seed and sample data and will copy storefront data
for easy customization (if spree_frontend available). This can be disabled using
rails g spree:install --migrate=false --sample=false --seed=false --copy_storefront=falseYou can always perform any of these steps later by using these commands.
bundle exec rake railties:install:migrations
bundle exec rails db:migrate
bundle exec rails db:seed
bundle exec rake spree_sample:load
bundle exec rails g spree:frontend:copy_storefrontTo use Spree in API-only mode you need to replace spree with spree_api in your project Gemfile. This will skip Storefront and Admin Panel. If you would want to include the Admin Panel please add spree_backend to your Gemfile.
rails sGo to http://localhost:3000
Go to http://localhost:3000/admin
Spree Extensions provide additional features not present in the Core system.
| Extension | Spree 3.2+ support | Description |
|---|---|---|
| spree_gateway |  |
Payment Gateways (Stripe, Apple Pay, Braintree, Authorize.net and many others) |
| 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_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 |  |
Product Bundles |
| 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 |
| spree_volume_pricing |  |
It determines the price for a particular product variant with predefined ranges of quantities |
| better_spree_paypal_express |  |
This is the official Paypal Express extension for Spree. |
| spree_globalize |  |
Adds support for model translations (multi-language stores) |
| spree_avatax_official |  |
Improve your Spree store's sales tax decision automation with Avalara AvaTax |
| spree_analytics_trackers |  |
Adds support for Analytics Trackers (Google Analytics & Segment) |
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://github.com/spree/spree.git
cd spreeInstall the gem dependencies
bundle installCreate a sandbox Rails application for testing purposes which automatically performs all necessary database setup
bundle exec rake sandboxStart the server
cd sandbox
rails serverYou may notice that your Spree store runs slower 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 = falseAlso in development caching is disabled by default. To turn on caching run:
rails dev:cacheYou will need to restart rails server after this.
We use CircleCI to run the tests for Spree.
You can see the build statuses at https://circleci.com/gh/spree/spree.
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 specIf 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_GEMFILE=../Gemfile bundle exec rake test_appIf you want to run specs for only a single spec file
cd core
bundle exec rspec spec/models/spree/state_spec.rbIf you want to run a particular line of spec
cd core
bundle exec rspec spec/models/spree/state_spec.rb:7Spree 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:
- by using prerelease versions / master branch
- by reporting bugs
- by translating to a new language
- by writing or editing documentation
- by writing specs
- by writing needed code or finishing code
- by refactoring code
- by reviewing pull requests
- by verifying issues
Spree is released under the New BSD License.
Spark Solutions is a software development agency specialized in Ruby on Rails, Spree Commerce and Javascript development. We’ve been leading Spree open-source efforts since 2016 as its core team. We also do client work. Our project teams consist of UX and UI designers, Software Engineers, Testers and Project Managers practicing agile project delivery. We’ll integrate our team with yours to jointly architect, deliver, maintain and scale the software products you need. You drive the project with requirements and acceptance testing and we help you deliver faster using industry-standard project management and comms best practices.
We are passionate about open source software. We are available for hire.