Before starting this tutorial, please check which Rails version are you using by running:
bundle exec rails -v
in your project root directory.
Add Spree gems to your
Rails 6.0 and 6.1
gem 'spree', '~> 4.2' gem 'spree_auth_devise', '~> 4.3' gem 'spree_gateway', '~> 3.9' gem 'spree_i18n', '~> 5.0' gem 'sassc', github: 'sass/sassc-ruby', branch: 'master' # only needed for MacOS and Ruby 3.0
gem 'spree', '~> 3.7.0' gem 'spree_auth_devise', '~> 3.5' gem 'spree_gateway', '~> 3.4'
gem 'spree', '~> 3.5.0' gem 'spree_auth_devise', '~> 3.3' gem 'spree_gateway', '~> 3.3'
gem 'spree', '~> 3.2.0' gem 'spree_auth_devise', '~> 3.2.0' gem 'spree_gateway', '~> 3.2.0'
Note: if you run into
Bundler could not find compatible versions for gem "sprockets":error message, please run
Use the install generators to set up Spree
bundle exec rails g spree:install --user_class=Spree::User bundle exec rails g spree:auth:install bundle exec 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. This can be disabled using
rails g spree:install --migrate=false --sample=false --seed=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
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.
rails g spree:install is run inside an application, it will install Spree, mounting the
Spree::Core::Engine component by inserting this line automatically
mount Spree::Core::Engine, at: '/'
By default, all Spree routes will be available at the root of your domain. For example, if your domain is
/products URL will be available at
You can customize this simply by changing the
:at specification in
config/routes.rb to be something else. For example, if you would like Spree to be mounted at
/shop, you can write this:
mount Spree::Core::Engine, at: `/shop`
The different parts of Spree (API, Admin) will be mounted there as well, eg.
You now have a functional Spree application after running only a few commands!
To see your application in action, open a browser window and navigate to http://localhost:3000. You should see the Spree default home page:
To stop the web server, hit Ctrl-C in the terminal window where it’s running. In development mode, Spree does not generally require you to stop the server; changes you make in files will be automatically picked up by the server.
The next thing you’ll probably want to do is to log into the admin interface.
Use your browser window to navigate to
http://localhost:3000/admin. You can login with
[email protected] and password
Upon successful authentication, you should see the admin screen:
Feel free to explore some of the Admin Panel features that Spree has to offer and to verify that your installation is working properly.
If you’ve followed the steps described in this tutorial, you should now have a fully functional Spree application up and running.
We recommend you should continue to Customization section to learn how to modify and extend your Spree application.
To learn more about Spree internals please refer Core section.