Installation

Prerequisites

Before proceeding make sure you have Docker Desktop installed on your system. This is fairly straightforward but differs depending on which operating system you use.

If you would like to add Spree to your existing Ruby on Rails application, please follow this guide instead (for advanced users).

Windows

Windows users will need to install the Linux subsystem to proceed.

Installation

  1. Download Spree Starter​

  2. Unzip it

  3. Rename spree_starter-main directory as you please

  4. Run bin/setup in said directory

  5. Wait for the commands to execute (it can take around 2-3 minutes)

Hello, Spree Commerce

You now have a functional Spree application after running only a few commands!

To stop the webserver, hit Ctrl-C in the terminal window where it's running.

Connecting to the API

Your API server is up and running. Download our Open API doc and import it to Postman to start playing around. Your backend server URL is http://localhost:4000 so to grab the Products List you can use:

curl --request GET \
--url http://localhost:4000/api/v2/storefront/products \
--header 'Content-Type: application/json'

We recommend checking out our API reference for more details.

Logging Into the Admin Panel

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 log in with the username [email protected] and password spree123.

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.