Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 1.77 KB

README.md

File metadata and controls

63 lines (46 loc) · 1.77 KB
Raw

BucketList

Build Status Codacy Badge Coverage Status

This is an application that enables users to record and share things they want to achieve or experience before reaching a certain age and keeping track of their dreams and goals.

Features

The application has a couple of features as listed below:-

  • A user is able to Register and get an account in the app
  • A user is able to Login into the app using their credentials already supplied
  • A user is able to create, edit, update and delete Buckets
  • A user is also able to create, edit, update and delete Bucket Items

Setup

To start using this application, first clone it to your local machine by running

git clone https://github.com/jokamjohn/bucketlist.git
cd bucketlist

Create the virtual environment and activate it

virtualenv env
source env/bin/activate

Then install all the required dependencies

pip install -r requirements.txt

Then run the application

python run.py

To now view the application head over to

http://localhost:5000

UML

The application also has a UML diagram. For the structure of the app check it out here

Testing

You can then run the application tests using

cd bucketlist
nosetests tests