Spree Starter

This a dockerized Spree Commerce application template ready to for local development and deployment to cloud providers.

Deploy in the cloud

Local Installation

Using Docker (Recommended)

Install required tools and dependencies:

• Docker

Run setup script

bin/setup

This will automatically launch the application at http://localhost:4000/admin

(Optional) Import sample data such as products, categories, etc

docker-compose run web rake spree_sample:load

Launching local server

docker-compose up

Without Docker (not recommended for beginners)

Install required tools and dependencies

1. HomeBrew - https://brew.sh/

2. Install required packages

   brew install gpg postgresql redis imagemagick
   createuser -P -d postgres

3. RVM - https://rvm.io/

4. NVM - https://github.com/nvm-sh/nvm

5. Ruby - rvm install 3.0.2

6. Node - nvm install

7. Yarn - npm -g install yarn

Run setup script

bin/setup-no-docker

Adding Storefront

Spree is a headless e-commerce platform which you can use with any storefront you like. We have pre-built integrations with:

• Next.js Commerce
• Vue Storefront

Updating

Connect to the docker container

docker-compose run web bash

Run update commands

bundle update
bin/rails spree:install:migrations
bin/rails db:migrate

For additional instructions please visit Spree Upgrade Guides

Development

Launching rails console

docker-compose run web rails c

Launching bash console

docker-compose run web bash

Customization

Adding new gems

Update Gemfile and run

bundle install
docker-compose build

You will need to restart the server if running:

docker-compose restart

Environment variables

variable	description	default value
DEBUG_ASSETS	Enables/disables asset debugging in development	false
DB_POOL	database connection pool	5
MEMCACHED_POOL_SIZE	memcache connection pool	5
SENDGRID_API_KEY	API key to interface Sendgrid API

License

Spree Starter (formerly Spark Starter Kit) is copyright © 2015-2021 Spark Solutions Sp. z o.o.. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About Spark Solutions

Spree Starter is maintained and funded by Spark Solutions Sp. z o.o. The names and logos are trademarks of Spark Solutions Sp. z o.o.

We are passionate about open source software. We are available for hire.