- Join our Slack at slack.spreecommerce.com
- Extensions
- Documentation
- Spree success stories from OpenCommerce Conf
- 2016 Development Roadmap
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)
Required rails rails (~> 4.2.6)
Add Spree gems to your Gemfile:
gem 'spree', '~> 3.1.0'
gem 'spree_auth_devise', '~> 3.1.0'
gem 'spree_gateway', '~> 3.1.0'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:installAlternatively, 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. This can be disabled using
rails g spree:install --migrate=false --sample=false --seed=falseYou 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:loadSpree Extensions provide additional features not present in the Core system.
| Extension | Description |
|---|---|
| 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_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_active_shipping | Spree integration for Shopify's active_shipping gem |
| 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 |
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 = falseSpree 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 perform all necessary database setup
bundle exec rake sandboxStart the server
cd sandbox
rails serverWe 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 exec rake test_app
bundle exec rspec specIf you would like to run specs against a particular database you may specify the dummy apps database, which defaults to sqlite3.
DB=postgres bundle exec rake test_appIf you want to run specs for only a single spec file
bundle exec rspec spec/models/spree/state_spec.rbIf you want to run a particular line of spec
bundle exec rspec spec/models/spree/state_spec.rb:7You can also enable fail fast in order to stop tests at the first failure
FAIL_FAST=true bundle exec rspec spec/models/state_spec.rbIf you want to run the simplecov code coverage report
COVERAGE=true bundle exec rspec specIf you're working on multiple facets of Spree to test, please ensure that you have a postgres user:
createuser -s -r postgresAnd also ensure that you have PhantomJS installed as well:
brew update && brew install phantomjsTo 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:
bash build.shSpree 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.