More at Features | Support | Blog | Demo | Community | Download

Spree guides

These guides are designed to make you immediately productive with Spree, and to help you understand how all of the pieces fit together. They are written by the authors of Spree as well as members of the Spree community.

Start Here

Getting Started with Spree
Everything you need to know to install Spree and create your first application.
Working With the Source Code
An introduction to working with the source code..
Server Configuration
Steps to get your Spree application up and running in a production environment.

Basic Configuration

Products and Variants
This guide covers the basic representation of products and their possible variants.
Information on the powerful inventory management system used by Spree.
This guide covers various methods for categorizing your products.
This guide explains how Spreeā€™s payment system works and how to implement your own payment methods.
Payment Gateways
This guide covers how to setup a payment gateway using ActiveMerchant or another gateway solution of your choice.
This guide covers how to configure a zone for shipping, taxation or other custom purposes.
This guide covers the role that calculators play in various Spree operations.
Information on how to configure the tax calculations for your site (including Sales Tax and VAT.)
Information on how to configure shiping options as well as building your own shipping calculator.
Coupons and Discounts
Information on how to configure your own coupons/discounts/gift certificates.

Digging Deeper

This guide introduces the key ideas for customizing Spree to your site design.
Using Extensions
This guide covers the technical details of the extension system.
Customizing the Checkout Process
This guide will show you how to customize the steps in your checkout process.
Migrating Data to Spree
Some tips on how to transfer large amounts of data into Spree.
This guide covers issues related to using Spree in different countries and locales.
Boot Modes
Information on the different modes in which you can run Spree.
Testing Spree Applications
This guide covers how to test the Spree source code as well as how to write new tests.
Securing Spree Applications
Information on how to secure your Spree application (including roles and permissions settings.)
Information on how to administer the various preferences in Spree.
Details on interacting with Spree using the RESTful API.
Product Groups and Scopes
Information on how to define groups of products by various criteria.
Searching and Faceting
Information on how to support powerful search and filtering operations.
Contributing to Spree
Do you enjoy Spree and want to “give something back?” This guide contains information on how to contribute to the Spree project.
Release notes
Overview documentation for the recent releases

Best Practices

Developer Tips
This guide contains a miscellany of useful advice from Spree developers, including how to design your Spree project so as to minimize problems should you decide to upgrade to a newer version.
SEO Considerations
Information on how to leverage the existing SEO features of Spree as well as on general SEO best practices.