Skip to content

davishooly/FASTFOODFAST-API

Repository files navigation

FASTFOODFAST-API

license Build Status Coverage Status Codacy Badge PEP8 Python 3.6

Fast Food Fast

Fast food fast is a food delivery application.

How it Works

  • An admin creates food items
  • A normal user creates an account and can login
  • A logged in user can view available food items created by the admin
  • A user chooses on a food item and makes an order
  • An Admin can accept or reject the order request from a user
  • A user gets notified on his/her order status
  • Accepted orders are delivered

Prerequisite

Installation and Setup

Clone the repository below

git clone https://github.com/davishooly/FASTFOODFAST-API.git

Create and activate a virtual environment

virtualenv env --python=python3.6

source env/bin/activate

Install required Dependencies

pip install -r requirements.txt

Running the application

$ export FLASK_APP = run.py

$ export MODE = development

$ flask run

Endpoints Available

Method Endpoint Description Roles
POST /api/v2/auth/signup sign up a user users
POST /api/v2/users/<{id}>/orders post an order users
DELETE /api/v2/order/<{id}> delete a specific order users
POST /api/v2/menu post a fooditem Admin
GET /api/v2/orders get orders Admin
DELETE /api/v2/menu/<{id}> delete a specific food item Admin
PUT /api/v2/menu/<{id}> update a menu Admin
PUT /api/v2/orders/<{id}>/accept accept an order Admin
PUT /api/v2/orders/<{id}>/reject reject an order Admin
PUT /api/v2/orders/<{id}>/complete complete an order Admin
GET /api/v2/accepted/orders get accepted orders Admin
GET /api/v2/rejected/orders get rejected orders Admin
GET /api/completed/orders get completed orders Admin
POST /api/v2/auth/login login a user Admin/users
GET /api/v2/orders/<{id}> get a specific food order Admin/users
GET /api/v2/menu get menu Admin/users

Testing

nosetests

- Testing with coverage

nosetests --with-coverage --cover-package=app

Author

Kimame Davis

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published