shl

a shopping list web based application that allows users to create , track their shopping needs as well as share their shopping lists with others

Description

> The innovative -----shopping list app----- is an application that  -----allows users  
> to record and share things they want to spend money on ----- meeting the needs of -----keeping track of their shopping lists -----.

Requirements

> 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

Interface:

the home page

Installation

Dependencies

1. Flask
2. Flask-wtf
3. flask-login
4. Flask-Moment
5. Flask-Script

process:

Download python version 3.4.3 or above and install and make sure you have git installed too
open command line; install virtualEnv

pip install VirtualEnv
clone repository from git

git clone https://github.com/p-netm/shl.git
create a virtual environment; is a placeholder for any arbitrary name

VirtualEnv
install all the dependencies

pip install -r requirements.txt
Testing:

nosetests

Configurations

configuration variables

    format on windows:
    set KEY=<value>
    on unix:
    export KEY=<value>

key                 value-options
----                ------
SECRET_KEY          <surprise me>
CONFIGURATION       {'development', 'production', 'testing', 'default'='development'}

Deploy

> Python manage.py runserver
    * Restarting with stat
    * Debugger is active!
    * Debugger PIN: ###-###-###
    * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

USE and FEATURES

first page and login page for unkown users

registration page

add new list

Enables user to add a new list with a unique name each time

add a new item

A user can add an item to an active list: the add_item link is on the navigation and pops up the modal shown below

Modification

a User can modify each and every aspect of a shopping list or an item. such fields are however limited to all that require user input

Viewing Public ShoppingLists

Given that a user may know the user_name of another user. Hir can create a url that displays the second users shopping lists. However the first user cannot edit or delete these or any other lists that they do not own(create)

Aknowledgements

All of this would have never been possible without the support of my two LFAs Boswell and Dennis, they were instrumental in providing very useful feedback and help. Special thanks goes to my team

* Rahma 
* Gatana
* Leo
* Abdul
* and me

who always reminded and showed me what true collaboration means and feels like.

p-netm / shl Goto Github PK

shl's Introduction

shl