README.md

Spree Starter (formerly Spark Starter Kit)

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

Launch on Heroku

Local Installation

Install required tools and dependencies:

• Docker with docker-compose

Run setup script

bin/setup

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

docker-compose run web rake spree_sample:load

Launching local server

docker-compose up

Updating

bundle update spree
docker-compose build

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.