# KktShoppe

KktShoppe is an Rails-based e-commerce platform which allows you to easily introduce a
catalogue-based store into your Rails 4 applications.

![GemVersion](https://badge.fury.io/rb/kkt_shoppe.png)
[![Code Climate](https://codeclimate.com/github/trykkt_shoppe/core/badges/gpa.svg)](https://codeclimate.com/github/trykkt_shoppe/core)
[![Build Status](https://travis-ci.org/trykkt_shoppe/kkt_shoppe.svg?branch=master)](https://travis-ci.org/trykkt_shoppe/kkt_shoppe)

* [Check out the website](http://trykkt_shoppe.com)
* [View the demo site](http://demo.trykkt_shoppe.com)
* [Check out the demo site source](http://github.com/trykkt_shoppe/example-store)
* [Read the release notes](https://github.com/trykkt_shoppe/core/blob/master/CHANGELOG.md)
* [Read API documentation](http://api.trykkt_shoppe.com)

## Features

* An attractive & easy to use admin interface with integrated authentication
* Full product/catalogue management
* Stock control
* Tax management
* Flexible & customisable order flow
* Delivery/shipping control, management & weight-based calculation

## Getting Started

KktShoppe provides the core framework for the store and you're responsible for creating
the storefront which your customers will use to purchase products. In addition to
creating the UI for the frontend, you are also responsible for integrating with whatever
payment gateway takes your fancy.

### Installing into a new Rails application

To get up and running with KktShoppe in a new Rails application is simple. Just follow the
instructions below and you'll be up and running in minutes.

    rails new my_store
    cd my_store
    echo "gem 'kkt_shoppe', '~> 1.0'" >> Gemfile
    bundle
    rails generate kkt_shoppe:setup
    rails generate nifty:key_value_store:migration
    rake db:migrate kkt_shoppe:setup
    rails server

## Contribution

If you'd like to help with this project, please get in touch with me. The best place is on
Twitter (@adamcooke) or by e-mail to adam@atechmedia.com.

## License

KktShoppe is licenced under the MIT license. Full details can be found in the MIT-LICENSE
file in the root of the repository.