This a dockerized Spree Commerce application template ready to for local development and deployment to cloud providers.
bin/start-docker
This will automatically launch the application at http://localhost:4000/admin
docker-compose run web rake spree_sample:load
docker-compose up
bin/start-hybrid
After loading all docker dependencies launch local server with:
bin/rails s
docker-compose run web rake spree_sample:load
-
HomeBrew - https://brew.sh/
-
Install required packages: GPG, PostgreSQL, Redis, ImageMagick, and VIPS
brew install gpg postgresql redis imagemagick vips createuser -P -d postgres
-
RVM - https://rvm.io/
-
Ruby -
rvm install 3.0.3
-
Node -
nvm install
-
Yarn -
npm -g install yarn
bin/setup-no-docker
Spree is a headless e-commerce platform which you can use with any storefront you like. We have pre-built integrations with:
docker-compose run web bash
bundle update
bin/rails spree:install:migrations
bin/rails db:migrate
For additional instructions please visit Spree Upgrade Guides
docker-compose run web rails c
docker-compose run web bash
Update Gemfile
and run
bundle install
docker-compose build
You will need to restart the server if running:
docker-compose restart
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 |
If you are building the application using the latest code, you may encounter the following libvips error:
LoadError: Could not open library 'vips.so.42'
This error is usually an indication that you do not have libvips installed locally on your machine. Check that libvips is installed with vips -v
, and if it is not installed, follow installation instructions here.
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.
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.