README.md in spree-1.1.6 vs README.md in spree-1.2.0.rc1

- old
+ new

@@ -1,39 +1,42 @@ +**THIS README IS FOR THE MASTER BRANCH OF SPREE AND REFLECTS THE WORK CURRENTLY EXISTING ON THE MASTER BRANCH. IF YOU ARE WISHING TO USE A NON-MASTER BRANCH OF +SPREE, PLEASE CONSULT THAT BRANCH'S README AND NOT THIS ONE.** + SUMMARY ------- + Spree is a complete open source e-commerce solution built with Ruby on Rails. It was originally developed by Sean Schofield and is now maintained by a dedicated [core team](http://spreecommerce.com/core-team). You can find out more by visiting the [Spree e-commerce project page](http://spreecommerce.com). Spree actually consists of several different gems, each of which are maintained in a single repository and documented in a single set of [online documentation](http://spreecommerce.com/documentation). By requiring the Spree gem you automatically require all of the necessary gem dependencies which are: * spree_api -* spree_auth * spree_cmd * spree_core * spree_dash * spree_promo * spree_sample 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. So for example, you could use just the barebones spree\_core gem -and perhaps combine it with your own custom authorization scheme instead of using spree_auth. +and perhaps combine it with your own custom promotion scheme instead of using spree_promo. -[![Build Status](https://secure.travis-ci.org/spree/spree.png?branch=1-1-stable)](https://travis-ci.org/spree/spree) +[![Build Status](https://secure.travis-ci.org/spree/spree.png)](http://travis-ci.org/spree/spree) Installation ------------ The fastest way to get started is by using the spree command line tool available in the spree gem which will add Spree to an existing Rails application. - $ gem install rails -v 3.2.12 + $ gem install rails -v 3.2.7 $ gem install spree - $ rails _3.2.12_ new my_store + $ rails _3.2.7_ new my_store $ spree install my_store This will add the Spree gem to your Gemfile, create initializers, copy migrations and optionally generate sample products and orders. @@ -50,11 +53,11 @@ You can manually add Spree to your Rails 3.2.x application. Add Spree to your Gemfile. ```ruby -gem 'spree', '1.1.6.beta' +gem 'spree', :git => 'git://github.com/spree/spree.git' ``` Update your bundle $ bundle install @@ -95,25 +98,25 @@ The source code is essentially a collection of gems. Spree 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. 1. Clone the Git repo - $ git clone git://github.com/spree/spree.git - $ cd spree + git clone git://github.com/spree/spree.git + cd spree 2. Install the gem dependencies - $ bundle install + bundle install 3. Create a sandbox Rails application for testing purposes (and automatically perform all necessary database setup) - $ bundle exec rake sandbox + bundle exec rake sandbox 4. Start the server - $ cd sandbox - $ rails server + cd sandbox + rails server Performance ----------- You may noticed that your Spree store runs slowly in development mode. This is a side-effect of how Rails works in development mode which is to continuous 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. @@ -124,18 +127,28 @@ If you want to remove precompiled assets (recommended before you commit to Git and push your changes) use the following rake task: $ bundle exec rake assets:clean -Running Tests -------------- +Use Dedicated Spree Devise Authentication +----------------------------------------- +Add the following to your Gemfile -If you want to run all the tests across all the gems then + $ gem 'spree_auth_devise', :git => 'git://github.com/spree/spree_auth_devise' + +Then run `bundle install`. Authentication will then work exactly as it did in previous versions of Spree. - $ cd spree - $ bundle exec rake +If you're installing this in a new Spree 1.2+ application, you'll need to install and run the migrations with + $ bundle exec rake spree_auth:install:migrations + $ bundle exec rake db:migrate + +and then run `bundle exec rake spree_auth:admin:create` in order to set up the admin user for the application. + +Running Tests +------------- + 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 @@ -158,9 +171,18 @@ $ bundle exec rspec spec/models/state_spec.rb If you want to run a particular line of spec $ bundle exec rspec spec/models/state_spec.rb:7 + +Travis, the continuous integration service, runs the test suite for each gem one at a time. + + $ alias set_gemfile='export BUNDLE_GEMFILE="`pwd`/Gemfile"' + $ bundle exec rake test_app + $ cd api; set_gemfile; bundle install; bundle exec rspec spec + $ cd ../core; set_gemfile; bundle install; bundle exec rspec spec + $ cd ../dash; set_gemfile; bundle install; bundle exec rspec spec + $ cd ../promo; set_gemfile; bundle install; bundle exec rspec spec Contributing ------------