shopping-list

Is a flask powered web application that allows users to keep track of their shopping items and also allows a user to share the shopping lists with others, this web application also allows you to mark items that you have already

Prerequisites

• Python3 Installation
• Git Installation

Usage

1. Clone this repo git clone https://github.com/gr1d99/shopping-list.git
2. Change your current directory to shopping-list
3. On your terminal type git checkout develop
4. Create a virtual enviroment virtualenv --python=python3 env then activate it source env/bin/activate
5. Install requirements pip3 install -r requirements.txt
6. Generate your SECRET_KEY by running python manage.py generate_secret, the command will generate a secret.txt file that will contain the apps secret key, after running the command, copy the generated key and use it to set enviroment variable SECRET_KEY so that it will be available to the app configuration. eg.

$ export SECRET_KEY=<generated key goes here>

DEBUG is set to True but you may change it.

7. Finally deploy your web app by running the command python manage.py runserver

The app does not have much functionality. What you can do for now is

• Create an account
• Login
• create/retrieve/update and delete shopping lists through the dashboard.
• create/retrieve/update and delete shopping items.
• add shopping items to a shopping list.
• view created shopping list and its items.
• mark and un-mark shopping items.

Running the tests

All tests are located in the root of the project in a folder named tests.

nose

Test the project using nose and view coverage report on your terminal

 $ nosetests --with-coverage

Deployment

This app can be deployed on Heroku cloud.

deploy on heroku with git

if you do not have any expirience with heroku kindly start here to get some basics

1. create an account on heroku.
2. read this article and use it as a reference.

Built with

1. Flask

Authors

Gideon Kimutai

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Andela Kenya
• Boot-camp LFAs
• The A-TEAM members(both week one and week two team)
• All candidates.

Demo

Shopping List App

Screenshots

About page

Home page before login

Signup Page

Login Page

Home Page after login

Create Shopping List

Dashboard

View Shopping List

Edit Shopping Item