Skip to content

malikwahab/bucketlist-django-application

Repository files navigation

Build Status Coverage Status Scrutinizer Code Quality

Bucketlist Django Application (Buppli)

A bucketlist application in Django with API endpoint

Introduction

Buppli is an application for creating and managing a bucketlist, with available API to perform the actions. Built with django-restful-framework, it implements token Based Authentication for the API and only methods to register and login are accessible to unauthenticated users. Data is exchanged as JSON.

API Documentation

Documentation is available here

Installation

Clone the repo

git clone https://github.com/andela-aabdulwahab/bucketlist-django-application.git

After cloning, create a virtual environment and install the requirements. For Linux and Mac users:

$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements

If you are on Windows, then use the following commands instead:

$ virtualenv venv
$ venv\Scripts\activate
(venv) $ pip install -r requirements.txt

Perform migrations

python manage.py makemigrations
python manage.py migrate

Testing

To run the tests for the app, and see the coverage, run

python manage.py test

About

A bucketlist application in Django with API endpoint.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published