Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 3.13 KB

README.md

File metadata and controls

70 lines (49 loc) · 3.13 KB

simple-shop

Codacy Badge Circle CI Updates Python 3

This project is a sample coding exercise implementing a simple shop front with products, categories and shopping cart integration.

Finished all-in-one solutions like Django-Oscar or Cartridge for Mezzanine have been avoided on purpose although they would have covered everything and beyond.

Author: Sascha Peter Since: 2015-06-13

Requirements

To run this project, the following requirements need to be met:

  • Python 3.3+
  • Virtualenv
  • PIP (Package Manager for installing additional requirements)

Additional requirements

All additional packages can be found in pip-requirements.txt.

Installation of additional requirements

All additional packages can simply be installed by running:

pip install -r pip-requirements.txt

Features

Done

  • Creation and editing of products
  • Creation of product categories
  • Display of products within categories and product details
  • Shopping cart implementation to add, remove and display products
  • Implementation of vouchers
  • Disallow ordering more items than in stock
  • User Documentation for mac users

Outstanding

  • More unit tests

User Documentation

This project contains a small user documentation how to setup and install this project (currently only covers MAC). The user documentation can be found under docs/Simple-Shop_Documentation/tmpt/en-GB/ in a variety of formats.

The formats include:

  • epub (untested)
  • html
  • html-desktop
  • html-single
  • pdf
  • txt
  • xml

Please note that due to licencing of the documentation, it is not suitable for printing.

Copyright

This codebase, unless otherwise stated, is Copyright by Sascha Peter © 2015 [email protected].

This project incorporates third party libraries such as Django-Cart - and is licensed under GPLv3. The source code in this project has been modified to work with Python 3.3 / Django 1.8 and to support the features listed above . Author, license and source code files can be found in the djangocart folder - the original project can be found here.

The user documentation of this project has been written and generated with Publican - and may only be distributed subject to the terms and conditions set forth in the GNU Free Documentation License (GFDL), V1.2 or later (the latest version is presently available here).