From 772d62087c33667f5b76654602c7bea52a7d025c Mon Sep 17 00:00:00 2001 From: Adam Cooke Date: Mon, 7 Oct 2013 16:44:24 +0100 Subject: [PATCH] upgrade to the latest shoppe & add more docs --- Gemfile.lock | 2 +- README.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index d445bf6..70fdcee 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -92,7 +92,7 @@ GEM railties (>= 4.0.0.beta, < 5.0) sass (>= 3.1.10) sprockets-rails (~> 2.0.0) - shoppe (0.0.5) + shoppe (0.0.6) bcrypt-ruby (~> 3.0.0) coffee-rails dynamic_form diff --git a/README.md b/README.md index 28b67fc..5c17eca 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,34 @@ This is a Rails application which builds an entire e-commerce store with a lovely design which can be used as a template for building new stores or just for exploring the functionality provided by the Shoppe platform. + +## Getting Started + +To get started using the example store provided here is simple. Just follow the instructions +below and you'll be up and running in minutes with a demo store with demo data. + +``` +$ git clone git://github.com/niftyware/shoppe-example.git +$ cd shoppe-example + +$ cp config/shoppe.example.yml config/shoppe.yml +# -> Add the appropriate SMTP server configuration to shoppe.yml + +$ cp config/database.example.yml config/database.yml +# -> Add the appropriate database configuration to database.yml + +$ bundle +$ rake db:migrate shoppe:create_default_user shoppe:seed +$ rails server +``` + +A few notes about this demo store: + +* The store does not currently implement any payment integration. It will ask + for card details during checkout but these will not be checked. + +* The design remains copyright Niftyware Limited. Please do not use the design + wholesale for any sites you may be developing. + +* Once up and running, you can access the Shoppe interface at `/shoppe` and use + **admin@example.com** and **password** to login.