pluwum/shopping-list

[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate/badges/gpa.svg)](https://codeclimate.com/github/pluwum/shopping-list)
[![Test Coverage](https://codeclimate.com/github/codeclimate/codeclimate/badges/coverage.svg)](https://codeclimate.com/github/pluwum/shopping-list)
[![Build Status](https://travis-ci.org/pluwum/shopping-list.svg?branch=challenge-2)](https://travis-ci.org/pluwum/shopping-list)
 
# Shopping-List App
The shopping List App is an application that allows users to record and share things they want to spend money on by allowing users to keep track of their shopping lists.
 
## FEATURES
 - Users create accounts
 - Users can log in
 - Users create, view, update and delete shopping lists.
 - Users can add, update, view or delete items in a shopping list
 
## FOLDER STRUCTURE
  - app: contains all core application logic
  - tests: contains unit tests for the application logic in the app folder
  - wireframes: Contains a collection of ui design sketches
  - designs: This folder contains all UML class diagrams and documentation
 
## Motivation
 
This project is part of a submission for week two of Andela BootCamp UG CH3 2017. All the features available are developed as specified by the assignment
 
## Python Version
 
Python 3.6.1
 
## Installation
 
#### Step 1
Install a  virtual environment
To install  the virtualenvwrapper follow the link installing [Installing Virtual Environment](http://docs.python-guide.org/en/latest/dev/virtualenvs/).
 
#### Step 2
Clone Github repository
 
```
$ git clone https://github.com/pluwum/shopping-list.git
 
```
 
#### Step 3
Install the required dependencies
 
```
$ pip install -r requirements.txt
 
```
alternatively
 
```
$ pip install --upgrade -r requirements.txt
 
```
 
#### Step 5
### Running the application
Navigate to the root directory and and run the following command:
 
```
$ python app.py
 
```
 
The application can be found by entering the following url in your browser
 
```
http://127.0.0.1:5000/
 
```
## Demo Version
 
A Demo version of this simple App can be accessed [HERE](https://pacific-wave-55880.herokuapp.com/)
## Contributors
 
This project is maintained by  [Patrick Luwum](https://twitter.com/luwyx)