Giter VIP home page Giter VIP logo

spree_starter's Introduction

Spree Starter

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

Deploy in the cloud

Deploy

Deploy to Render

Local Installation

Using Docker (Recommended)

Install required tools and dependencies:

Run setup script

bin/start-docker

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

Using Hybrid installation

Install required tools and dependencies:

Run setup script

bin/start-hybrid

After loading all docker dependencies launch local server with:

bin/rails s

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

docker-compose run web rake spree_sample:load

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.3

  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:

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

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.

spree_starter's People

Contributors

damianlegawiec avatar dependabot-preview[bot] avatar krzysiek1507 avatar punkbooster avatar dependabot-support avatar pl-spark avatar dependabot[bot] avatar karol-the-guy avatar niewskici avatar rafalkosla101 avatar rafalcymerys avatar nadberezny avatar kgorazd avatar ridem avatar tniezg avatar arudnicka avatar andrewwu avatar argonus avatar bbonislawski avatar chrisdobler avatar johnbeynon avatar kshalot avatar aplegatt avatar jdatti avatar piotrekpasciak avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.