Spree Commerce

• 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 ofonline 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)

Demo

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

Installation

Create new Rails app (optional)

If you're starting a new application from scrach run:

rails new my\_store cd my\_store

You can add Spree to your existing Rails application as well.

Add Spree gems to your

Gemfile

Rails 6.0

gem 'spree', '~\> 4.1' gem 'spree\_auth\_devise', '~\> 4.1' gem 'spree\_gateway', '~\> 3.7'

Rails 5.2

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 -v

Older rails versions are also supported: Rails 5.1, Rails 5.0, Rails 4.2

Install gems

bundle install

Note: if you run into

Bundler could not find compatible versions for gem "sprockets":

error message, please run

bundle update

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

By 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=false

You 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\_storefront

Headless installation

To 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.

Run rails sever

rails s

Browse Storefront

Go to http://localhost:3000

Browse Admin Panel

Go to http://localhost:3000/admin

Extensions

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

| Extension | Spree 3.2+ support | Description | | --- | --- | --- | | spree_analytics_trackers | | Adds support for Analytics Trackers (Google Analytics & Segment) | spree_avatax_official | | Improve your Spree store's sales tax decision automation with Avalara AvaTax | spree_auth_devise | | Provides authentication services for Spree, using the Devise gem. | better_spree_paypal_express | | This is the official Paypal Express extension for Spree. | spree_braintree_vzero | | Official Spree Braintree v.zero + PayPal extension | | spree_contact_us | | Adds Contact Us form | | spree_digital | | A Spree extension to enable downloadable products | | spree_gateway | | Payment Gateways (Stripe, Apple Pay, Braintree, Authorize.net and many others) | spree_editor | | Rich text editor for Spree with Image and File uploading in-place | | spree_globalize | | Adds support for model translations (multi-language stores) | spree_i18n | | I18n translation files for Spree Commerce | spree-mollie-gateway | | Official Mollie payment gateway for Spree Commerce. | | spree_multi_currency | | Provides UI to allow configuring multiple currencies in Spree | | spree-multi-domain | | Multiple Spree stores on different domains - single unified backed for processing orders | spree_multi_vendor | | Spree Multi Vendor Marketplace extension | | spree-product-assembly | | Product Bundles | | spree_recently_viewed | | Recently viewed products in Spree | | spree_related_products | | Related products extension for Spree | spree_social | | Building block for spree social networking features (provides authentication and account linkage) | | spree_sitemap | | Sitemap Generator for Spree | | spree_shared | | Multi-tenancy for Spree using Apartment (per tenant databases) | | spree_static_content | | Manage static pages for Spree | | spree_volume_pricing | | It determines the price for a particular product variant with predefined ranges of quantities | spree_wishlist | | Wishlist extension for Spree |

Developing Spree

Please follow this guide

Contributing

Spree is an open source project and we encourage contributions. Please review thecontributing guidelinesbefore 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

License

Spree is released under the New BSD License.

About Spark Solutions

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.