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.

Windows

Windows users will need to install 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 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.

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 login 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.