SUMMARY

Spree is a complete open source commerce solution for Ruby on Rails. It was developed by Sean Schofield under the original name of Rails Cart before changing its name to Spree.

Refer to the Spree ecommerce project page to learn more.

QUICK START

Running the Gem

1. Install spree Gem (can take a while to install missing gem dependencies)

    (sudo) gem install spree
   

2. Create Spree Application

    spree <app_name>
    cd <app-name>
   

3. Create your database and edit the config/database.yml to taste.

    rake db:create
   

   You can skip this step if using sqlite3 as your database.

4. Bootstrap

    rake db:bootstrap
   

5. Launch Application

    script/server
   

Browse Store

http://localhost:nnnn/store

Browse Admin Interface

http://localhost:nnnn/admin

Running from edge sources (latest and greatest features)

1. Clone the git repo

    git clone git://github.com/railsdog/spree.git spree
    cd spree
   

2. Create the necessary config/database.yml file

3. Install the gem dependencies

    (sudo) rake gems:install
   

4. Bootstrap the database (run the migrations, create admin account, optionally load sample data.)

    rake db:bootstrap
   

5. Start the server

    script/server
   

Contributing

Spree is an open source project. We encourage contributions. Please see the contributors guidelines before contributing. Do not send a Github pull request - it will be ignored.