Spree API is written in Ruby on Rails framework and is mounted into a Rails application as a Rails Engine.
You don't need to be a Rails developer to work with Spree. You can install Spree via Spree Starter or Docker and not touch the underlying codebase at all and work only with the APIs.
All Spree models, controllers and other Ruby classes are namespaced by the
Spree keyword, eg.
Spree::Product. This means that those files are also located in
spree sub-directories eg. app/models/spree/product.rb.
Clone the your fork repository
git clone git://github.com/your_github_username/spree.gitcd spree
Install required libraries
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && brew install openssl mysql postgresql sqlite imagemagick redis
Install the gem dependencies
Bellow command will setup a Rails application with Spree pre-installed with some data seeded:
bundle exec rake sandbox
By default Sandbox uses SQLite database. But you can switch to PostgreSQL:
DB=postgres bundle exec rake sandbox
DB=mysql bundle exec rake sandbox
Start the server
cd sandboxbin/rails s
You may notice that your Spree store runs slower in development environment. This is caused by disabled caching and automatic reloading of code after each change.
Caching is disabled by default. To turn on caching please run:
You will need to restart rails server after this change.
Create a new branch for your changes. Do not push changes to the main branch. Branch name should be human-readable and informative, eg.
We use CircleCI to run the tests for Spree.
You can see the build statuses at https://circleci.com/gh/spree/spree.
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 corebundle exec rake test_appbundle exec rspec
If you would like to run specs against a particular database you may specify the dummy app's database, which defaults to sqlite3.
DB=postgres bundle exec rake test_app
If you want to run specs for only a single spec file
cd corebundle exec rspec spec/models/spree/state_spec.rb
If you want to run a particular line of spec
cd corebundle exec rspec spec/models/spree/state_spec.rb:7
We use chromedriver to run integration tests. To install it please use this command:
brew cask install chromedriver
Please keep your commit history meaningful and clear. This guide covers it quite well and we recommend reading it, not only for Spree project but for any IT project overall.
Push your changes to a topic branch in your fork of the repository.
git push -u origin fix/order-recalculation-total-bug
Create a Pull request - please follow this guide
If your changes references Github issues, please mark which issue you're fixing by adding
Fixes #<number or url of the issue> in the commit name or PR title/description. This will automatically mark that issue as closed when your PR will be merged.
Wait for CI to pass
If CI passed wait for Spree Core team code review
We're aiming to review and leave feedback as soon as possible. We'll leave you a meaningul feedback if needed.
Thank you for participating in Open Source and improving Spree - you're awesome!