Spree Starter

This is a starter kit for Spree Commerce - the open-source e-commerce platform for Rails. It is a great starting point for any Rails developer to quickly build an e-commerce store.

This starter uses:

Spree Commerce 4.8 which includes Admin Dashboard, API and Storefront
Ruby 3.3 and Ruby on Rails 7.1
Solid Queue with Mission Control UI (access only to Spree admins) for background jobs
Solid Cache for excellent caching and performance

You don't need to install any additional tools or libraries to start developing with Spree Starter. Everything is already set up for you.

Installation

Make sure you have the following installed:

Docker with Docker Compose - installation instructions
Ruby 3.3 - installation instructions
Vips - installation instructions

bin/setup

If you want to use sample data (products, categories), you can load it using the following command:

bin/rake spree_sample:load

Switching to MySQL

By default, Spree Starter uses PostgreSQL. If you want to switch to MySQL, you can do so by running the following command:

bin/rails db:system:change --to=mysql

You will also need to run bin/setup again to install the MySQL adapter and create the database.

Launch local server

bin/rails s

Deployment

Using Render

Note that sample data does not automatically get loaded when deploying to Render with the default configuration. In order to add sample data, run the following commands in the web service shell:

bin/rake spree_sample:load

Using Heroku

Other platforms

Spree Starter is a standard Rails application, so you can deploy it to any platform that supports Ruby on Rails applications. You can also use Docker to deploy it to any container-based platform. Please check Spree Guides for more information.

Troubleshooting

libvips error

If you encounter an error like the following:

LoadError: Could not open library 'vips.so.42'

Please check that libvips is installed with vips -v, and if it is not installed, follow installation instructions here.

Commands list

# Git clone
git clone https://github.com/plyaskin/Spree sajm.wedtp.com

# Redis
curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list

sudo apt-get update
sudo apt-get install redis -y
sudo systemctl enable redis-server.service
sudo systemctl start redis-server.service

# PostgreSQL
sudo apt install postgresql -y

################################## STOP ##################################
## Other stupid actions
# Change "port = " to other, ex. 5432 to 5439 and 6739 to 6732
sudo nano /etc/postgresql/14/main/postgresql.conf
sudo nano /etc/redis/redis.conf
################################## NEXT ##################################
sudo systemctl restart redis
sudo systemctl restart postgresql

# Add Docker's official GPG key:
sudo apt-get update -y
sudo apt-get install ca-certificates curl -y
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update -y

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y

# Ruby 3.3.0
# sudo apt-get install ruby-full -y
sudo apt install gnupg2
gpg2 --keyserver hkp://keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
\curl -sSL https://get.rvm.io -o rvm.sh
cat rvm.sh
curl -L https://get.rvm.io | bash -s stable
source ~/.rvm/scripts/rvm
rvm install ruby 3.3.0
sudo ln -s /var/www/plyaskin/data/.rvm/rubies/ruby-3.3.0/bin/ruby /usr/bin/ruby
sudo ln -s /var/www/plyaskin/data/.rvm/rubies/ruby-3.3.0/bin/gem /usr/bin/gem
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/bundle /usr/local/bin/bundle

##################################################
gem install --user-install rake
gem install --user-install rackup
gem install --user-install rubygems-update
gem install --user-install syntax_suggest
gem install --user-install rdbg
gem install --user-install nokogiri
gem install --user-install bootsnap
gem install --user-install bundler
gem install --user-install executable-hooks
gem install --user-install puma
gem install --user-install tilt
gem install --user-install rdoc
gem install --user-install irb
gem install --user-install thor
# gem install --user-install ri
gem install --user-install rbs
gem install --user-install sprockets
gem install --user-install racc
gem install --user-install typeprof
# gem install --user-install executable-hooks-uninstaller
# gem install --user-install pumactl
gem install --user-install rails
gem install --user-install erb


sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/rake /usr/local/bin/rake
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/rackup /usr/local/bin/rackup
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/update_rubygems /usr/local/bin/update_rubygems
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/syntax_suggest /usr/local/bin/syntax_suggest
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/rdbg /usr/local/bin/rdbg
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/nokogiri /usr/local/bin/nokogiri
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/bootsnap /usr/local/bin/bootsnap
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/bundler /usr/local/bin/bundler
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/ruby_executable_hooks /usr/local/bin/ruby_executable_hooks
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/puma /usr/local/bin/puma
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/tilt /usr/local/bin/tilt
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/rdoc /usr/local/bin/rdoc
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/irb /usr/local/bin/irb
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/thor /usr/local/bin/thor
# sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/ri /usr/local/bin/ri
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/rbs /usr/local/bin/rbs
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/sprockets /usr/local/bin/sprockets
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/racc /usr/local/bin/racc
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/typeprof /usr/local/bin/typeprof
# sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/executable-hooks-uninstaller /usr/local/bin/executable-hooks-uninstaller
# sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/pumactl /usr/local/bin/pumactl
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/rails /usr/local/bin/rails
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/erb /usr/local/bin/erb
sudo ln -s /var/www/plyaskin/data/.rvm/gems/ruby-3.3.0/bin/ /usr/local/bin/
##################################################

# Vips
sudo apt install libvips -y
sudo apt install libvips-tools -y

# NodeJS
sudo apt-get install nodejs -y

sudo apt install docker-compose -y
# sudo docker-compose up

sudo apt install postgresql-contrib libpq-dev
gem install bundler
gem update --system 3.5.10

bundle install
gem install bummr

sudo bin/setup

Name		Name	Last commit message	Last commit date
Latest commit History 17 Commits
.github		.github
app		app
bin		bin
config		config
db		db
lib		lib
log		log
public		public
storage		storage
test		test
tmp		tmp
vendor		vendor
.dockerignore		.dockerignore
.gitattributes		.gitattributes
.gitignore		.gitignore
.ruby-version		.ruby-version
Dockerfile		Dockerfile
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
LICENSE.md		LICENSE.md
Procfile		Procfile
README.md		README.md
Rakefile		Rakefile
app.json		app.json
config.ru		config.ru
docker-compose.yaml		docker-compose.yaml
render.yaml		render.yaml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Spree Starter

Installation

Switching to MySQL

Launch local server

Deployment

Using Render

Using Heroku

Other platforms

Troubleshooting

libvips error

Commands list

About

Releases

Packages

Languages

License

plyaskin/Spree

Folders and files

Latest commit

History

Repository files navigation

Spree Starter

Installation

Switching to MySQL

Launch local server

Deployment

Using Render

Using Heroku

Other platforms

Troubleshooting

libvips error

Commands list

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages