Solidus is a complete open source e-commerce solution built with Ruby on Rails. It is a fork of Spree.
Solidus actually consists of several different gems, each of which are maintained
in a single repository and documented in a single set of
online documentation. By requiring the
solidus gem you automatically require all
of the necessary gem dependencies which are:
solidus_frontend(Cart and storefront)
solidus_core(Essential models, mailers, and classes)
All of the gems are designed to work together to provide a fully functional
e-commerce platform. It is also possible, however, to use only the pieces you
are interested in. For example, you could use just the barebones
solidus_core gem and perhaps combine it with your own
custom frontend instead of using
Try out Solidus with one-click on Heroku:
To add solidus, begin with a Rails 5 application and a database configured and created. Add the following to your Gemfile.
gem 'solidus' gem 'solidus_auth_devise'
bundle command to install.
After installing gems, you'll have to run the generators to create necessary configuration files and migrations.
bundle exec rails g spree:install bundle exec rails g solidus:auth:install bundle exec rake railties:install:migrations
Run migrations to create the new models in the database.
bundle exec rake db:migrate
Finally start the rails server
bundle exec rails s
As part of running the above installation steps, you will be asked to set an admin email/password combination. The default values are
The best way to ask questions is via the #support channel on the Solidus Slack.
Instead of a stable build, if you want to use the bleeding edge version of Solidus, use this line:
gem 'solidus', github: 'solidusio/solidus'
Note: The master branch is not guaranteed to ever be in a fully functioning state. It is unwise to use this branch in a production system you care deeply about.
By default, the installation generator (
rails g spree:install) will run
migrations as well as adding seed and sample data. This can be disabled using
rails g spree:install --migrate=false --sample=false --seed=false
You can always perform any of these steps later by using these commands.
bundle exec rake railties:install:migrations bundle exec rake db:migrate bundle exec rake db:seed bundle exec rake spree_sample:load
There are also options and rake tasks provided by solidus_auth_devise.
You may notice that your Solidus store runs slowly in development mode. This
include. This can be disabled by adding the following to
config.assets.debug = false
To gain some extra speed you may enable Turbolinks inside of Solidus admin.
gem 'turbolinks', '~> 5.0.0' into your
Gemfile (if not already present) and append these lines to
CAUTION Please be aware that Turbolinks can break extensions and/or customizations to the Solidus admin. Use at own risk.
Clone the Git repo
git clone git://github.com/solidusio/solidus.git cd solidus
Install the gem dependencies
Solidus is meant to be run within the context of Rails application. You can easily create a sandbox application inside of your cloned source directory for testing purposes.
This sandbox includes solidus_auth_devise and generates with seed and sample data already loaded.
Create the sandbox application (
DB=postgresql can be specified
to override the default sqlite)
bundle exec rake sandbox
Start the server
cd sandbox rails server
We use CircleCI to run the tests for Solidus as well as all incoming pull requests. All pull requests must pass to be merged.
You can see the build statuses at https://circleci.com/gh/solidusio/solidus
To execute all the tests, run this command at the root of the Solidus project to run specs for all projects:
This runs using postgresql by default, but can be overridden by specifying
DB=mysql in the environment.
PhantomJS is required for the frontend and backend test suites.
Each gem contains its own series of tests.
To run the tests for the core project.
cd core bundle exec rspec
If you would like to run specs against a particular database you may specify the desired database, which defaults to sqlite3.
DB=postgresql bundle exec rspec
You can also enable fail fast in order to stop tests at the first failure
FAIL_FAST=true bundle exec rspec spec/models/state_spec.rb
If you want to run the simplecov code coverage report
COVERAGE=true bundle exec rspec
In addition to core functionality provided in Solidus, there are a number of ways to add features to your store that are not (or not yet) part of the core project.
A list can be found at extensions.solidus.io.
If you want to write an extension for Solidus, you can use the solidus_cmd gem.
Solidus is an open source project and we encourage contributions. Please read CONTRIBUTING.md before contributing.