Quickstart

Start building awesome e-commerce applications with Spree

Getting Started with Spree Commerce

Welcome to the Spree Commerce documentation guide. Follow the instructions below to learn how to build and deploy your Spree Commerce store.

1. Installing Spree

Creating Your Spree Repository

To create your Spree store repository please, follow these instructions:

Use Spree starter template to create your own repository

Setting up Your Development Environment

If you’re on Windows remember to install the Linux subsystem before proceeding.

1. Install git and Ruby

2. Once git is installed, clone your docs repository using

   git clone <your-repo>
   

   If you haven’t set it up yet, now would be a good time to do so with these SSH keys

3. Open a terminal and go to the repository directory

4. Run setup commands:

   bin/setup
   

5. And finally start the development server with:

   bin/rails s
   

Adding sample data

To add sample data to your store, run:

bin/rake spree_sample:load

This will add a some products, categories, and will setup a checkout flow to your store.

2. Exploring Your Store

Feel free to explore your store. You can do so because Spree comes with a default pre-built Storefront and Admin Panel.

Logging into the Admin Dashboard

Use your browser window to navigate to http://localhost:3000/admin. You can log in with the default credentials:

• login: [e-mail]
• 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.

Browsing Storefront

Spree comes with a default pre-built Storefront. You can access it by navigating to http://localhost:3000.

You can later customize this Storefront or choose another one if you prefer Next.js or Vue.js.

All Done!

Congrats! You’ve set up your Spree Commerce and it’s looking amazing! Need support or want to give some feedback? You can join our community or drop us an email at [e-mail].