Skip to content
This repository

Modular, Extensible open-source ecommerce solution for Ruby on Rails.

README.md

Piggybak Gem (Engine)

Modular / mountable ecommerce gem. Features:

  • Configurable tax methods, shipping methods, payment methods

  • One page checkout, with AJAX for shipping and tax calculations

  • Order processing completed in transaction, minimizing orphan data created

  • Fully defined backend RailsAdmin interface for adding orders on the backend

  • Piggybak 0.7.1 is compatible with Rails 4.1, 0.7.0 is compatible with Rails 4, and earlier version compatible with Rails 3.

Announcements

  • Variants were recently changed to sellables, to provide the opportunity for advanced variant support via an extension.

  • Significant recent rearchitecture has been applied to the order line items. Stay tuned for the documentation.

  • Review the new installation process below.

Installation

  • First create a new rails project: rails new webstore

  • Config your database.yml and create the databases

  • Add to Gemfile:

    gem "piggybak"
    
  • Next, run bundle install:

    bundle install
    
  • Next, run the piggybak install command:

    piggybak install
    
  • Add piggybak/piggybak-application to your main application.js:

    //= require piggybak/piggybak-application

(NOTE: If you run into an error saying that piggybak gem is missing, use bundle exec piggybak install)

  • Follow the instructions here to read more about the integration points and product configuration in Piggybak.

More Details

Visit the project website here to see more documentation and view a demo.

TODO

  • Ensure that changes in nested addresses are recorded on order notes.

Copyright

Copyright (c) 2014 End Point & Steph Skardal. See LICENSE for further details.

Something went wrong with that request. Please try again.