Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.69 KB

README.md

File metadata and controls

53 lines (34 loc) · 2.69 KB

SpreeFancy

SpreeFancy is a theme that can be applied to an existing spree application. It's intended as a starting point to show how a barebones Spree application can be easily modified to give a nice look and feel. As a special bonus it uses a responsive design so looks good on mobile devices as well as on larger screens.

If you'd like to see the theme in action, you can register for your own personal online sandbox which uses the same theme.

Installation

Themes in Spree are typically implemented as Spree extensions. To use the theme you will need an existing Spree application running Spree version 1.3 or higher. If you are unsure of how to do this you can find instructions on how to create a simple Spree application in the Spree README.

Once you have a rails application running Spree, it's a simple three step process to install the spree_fancy extension.

If you're using Spree 2.2, you will need to add the gem to your Gemfile using this line placed underneath the line for the Spree gem':

gem 'spree_fancy', :github => 'spree/spree_fancy', :branch => '2-2-stable'

If you are using Spree's master branch, then use this line:

gem 'spree_fancy', :github => 'spree/spree_fancy'

Then install the gem via Bundler:

$ bundle install

Finally, you need to run spree_fancy's installer:

$ bundle exec rails g spree_fancy:install

This copies over the migrations from the extension into your application, and sets up asset pipeline require statements for spree_fancy.

Usage

This theme alters the look and feel of the spree frontend, using the bxSlider jQuery plugin to present products on the front page. Products can appear in any of the 3 sliders: "Slider", "Featured" and "Latest". The plugin adds 3 taxonomies to control which products appear in the sliders. To try these out, sign in to the backend and try adding/removing the taxonomies to/from products and refresh the store front page to see how this affects the sliders.

This is achieved by overriding the index action in the Spree::HomeController using a Decorator. Have a look at the Decorators Guide for more information about using decorators to customize your application's logic.

Creating Your Own Extensions

To learn more about creating your own extensions, have a look in the Spree extensions tutorial

Copyright (c) 2012-2013 Spree Commerce Inc., released under the New BSD License