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.
- Current Release - based on the last stable release of Spree
- Edge Version - for unreleased code in current Spree master branch
- Legacy Guides - for legacy versions of Spree
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 Config & Deployment
- Overview & Deployment Options
-
Overview of Spree's server requirements and deployment options.
- Spree Deployment Service
-
Detailed walkthrough of using the Deployment Service to build a production environment.
- Deploying on Heroku
- Deploying on Ubuntu
-
Explains how to deploy your application to servers that have been configured by the Deployment Service
- Server Config. & Customization
-
Covers the basic configuration of servers built using the deployment service, and how to customize the configuration.
- Application Processes
-
Details the use of the Foreman gem to define and manage applications processes.
- Requesting and configuring SSL
-
How to generate a certificate request and private key, and install an SSL certificate.
- Configuration Tips
-
General troubleshooting and configuration tips
Basic Configuration
- Products and Variants
-
This guide covers the basic representation of products and their possible variants.
- Inventory
-
Information on the powerful inventory management system used by Spree
- Taxonomy/Categorization
-
This guide covers various methods for categorizing your products.
- Payments
-
This guides 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
- Zones
-
This guide covers how to configure a zone for shipping, taxation or other custom purpose.
- Adjustments
-
This guide covers the role that adjustments in taxation, shipping and promotions.
- Taxation
-
Information on how to configure the tax calculations for your site (including Sales Tax and VAT.)
- Shipping
-
Information on how to configure shipping options as well as building your own shipping calculator.
- Promotions
-
Using and extending the promotion system to provide discount coupons and other offers to customers
Customization
- Customization Overview
-
The guide introduces the various options available when customizing a Spree site.
- View Customization
-
Covers how to change and extend the standard views the make up a Spree application.
- Asset Customization
-
Explains Spree's use of the Rails asset pipeline, and how to customized the javascripts, stylesheets and images provided by Spree.
- Logic Customization
-
Highlights the options available when replacing / extending the internal code of Spree.
- Extensions & Themes
-
This guide covers the technical details of the extension system.
- Creating Extensions
-
This guide covers how to create an extension.
- Custom Authentication
-
This guide covers how to use a custom authentication setup with Spree.
Digging Deeper
- Spree Checkout Process
-
This guides covers the Spree checkout process and shows you how to customize the steps.
- Migrating Data to Spree
-
Some tips on how to transfer large amounts of data into Spree.
- Internationalization/Localization
-
This guide covers issues related to using Spree in different countries and locales.
- 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 permission settings.)
- Preferences
-
Information on how to administer the the various preferences in Spree
- REST API
-
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.
- After Launch
-
Launching your store isn't the end. Besides fulfilling orders, this guide covers other things you can do to help your store.
Best Practices
- Developer Tips
-
This guides 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.
