Skip to main content
Spree Commerce - Open Source e-commerce platform

​
Getting Started with Spree Commerce

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

​
1. Installing Spree

  • Spree Installer
  • Manual Installation
Use the guided installer to set up your Spree Commerce application with all the required dependencies (Ruby, Rails, etc.) on your system.Copy and paste the following command to your terminal:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/spree/spree/main/install.sh)"
This will fire up the guided installer that will ask you a few questions (eg. application name, load sample data, etc.) and then set up your Spree Commerce application.
On Windows please install WSL (Windows Subsystem for Linux) first.
wsl --install
Then run the installer from within WSL.
Minimum system requirements for MacOS:
  • MacOS 14.0+
  • XCode command line tools installed
If you have any issues with the installer, please create an issue on GitHub. Thank you!

​
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.
Spree comes with a default pre-built Storefront. You can access it by navigating to http://localhost:3000.

Spree Storefront

You can learn more about Storefront configuration in the Storefront section.
Use your browser window to navigate to http://localhost:3000/admin. You can log in with the default credentials:login:
spree@example.com
password:
spree123
Upon successful authentication, you should see the admin screen:

Spree Admin Dashboard

Feel free to explore some of the Admin Panel features that Spree has to offer and to verify that your installation is working properly.

​
All Done!

Congrats! You’ve set up your Spree Commerce and it’s looking amazing! Give Spree a GitHub Star, why dont’t ya? Thank you for supporting Spree open-source! Need support or want to give some feedback? Join our community with 6000+ members or drop us an email at hello@spreecommerce.org.