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.
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:
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.
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:
Note: if you run into
Bundler could not find compatible versions for gem "sprockets": error message, please run
rails g spree:install --user_class=Spree::User rails g spree:auth:install rails g spree_gateway:install
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
To use Spree in API-only mode you need to replace
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.
Go to http://localhost:3000
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
Please follow this guide
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.
We are passionate about open source software. We are available for hire.