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_api (RESTful API)
- solidus_frontend (User-facing components)
- solidus_backend (Admin area)
- solidus_core (Models & Mailers, the basic components of Solidus that it can't run without)
- solidus_sample (Sample data)
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 solidus_frontend.
To add solidus, begin with a rails 4.2 application. Add the following to your Gemfile.
gem 'solidus'
gem 'solidus_auth_devise'
Run the 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 rake railties:install:migrations
Run migrations to create the new models in the database.
bundle exec rake db:migrate
To use a stable build of Spree, you can manually add Spree to your Rails application. To use the 2-4-stable branch of Spree, add this line to your Gemfile.
gem 'solidus'
Alternatively, 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.
If you wish to have authentication included also, you will need to add the
solidus_auth_devise
gem as well.
gem 'solidus_auth_devise'
Once you've done that, then you can install these gems using this command:
bundle install
Use the install generator to set up Solidus:
rails g spree:install --sample=false --seed=false
At this point, if you are using solidus_auth_devise you will need to change this
line in config/initializers/spree.rb
:
Spree.user_class = "Spree::LegacyUser"
To this:
Spree.user_class = "Spree::User"
You can avoid running migrations or generating seed and sample data by passing in these flags:
rails g spree:install --migrate=false --sample=false --seed=false
You can always perform the 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
The source code is essentially a collection of gems. 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.
- Clone the Git repo
git clone git://github.com/solidusio/solidus.git
cd solidus
- Install the gem dependencies
bundle install
- Create a sandbox Rails application for testing purposes (and automatically perform all necessary database setup)
bundle exec rake sandbox
- Start the server
cd sandbox
rails server
You may notice that your Solidus store runs slowly in development mode. This is a side-effect of how Rails works in development mode which is to continuously reload your Ruby objects on each request. The introduction of the asset pipeline in Rails 3.1 made default performance in development mode significantly worse. There are, however, a few tricks to speeding up performance in development mode.
First, in your config/development.rb
:
config.assets.debug = false
You can precompile your assets as follows:
RAILS_ENV=development bundle exec rake assets:precompile
If you want to remove precompiled assets (recommended before you commit to Git and push your changes) use the following rake task:
RAILS_ENV=development bundle exec rake assets:clean
Add the following to your Gemfile
gem 'solidus_auth_devise', github: 'solidusio/solidus_auth_devise'
Then run bundle install
. Authentication will then work exactly as it did in
previous versions of Spree.
If you're installing this in a new Solidus application, you'll need to install and run the migrations with
bundle exec rake spree_auth:install:migrations
bundle exec rake db:migrate
change the following line in config/initializers/spree.rb
Spree.user_class = 'Spree::LegacyUser'
to
Spree.user_class = 'Spree::User'
In order to set up the admin user for the application you should then run:
bundle exec rake spree_auth:admin:create
We use CircleCI to run the tests for Solidus.
You can see the build statuses at https://circleci.com/gh/solidusio/solidus
Each gem contains its own series of tests, and for each directory, you need to do a quick one-time creation of a test application and then you can use it to run the tests. For example, to run the tests for the core project.
cd core
bundle exec rake test_app
bundle exec rspec spec
If you would like to run specs against a particular database you may specify the dummy apps database, which defaults to sqlite3.
DB=postgres bundle exec rake test_app
If you want to run specs for only a single spec file
bundle exec rspec spec/models/spree/state_spec.rb
If you want to run a particular line of spec
bundle exec rspec spec/models/spree/state_spec.rb:7
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 spec
If you're working on multiple facets of Solidus to test, please ensure that you have a postgres user:
createuser -s -r postgres
And also ensure that you have PhantomJS installed as well:
brew update && brew install phantomjs
To execute all the tests, you may want to run this command at the root of the Solidus project to generate test applications and run specs for all the facets:
bash build.sh
Solidus is an open source project and we encourage contributions. Please read CONTRIBUTING.md before contributing.