Skip to content

BrodaOJ56/flask-delivery-pizza-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License Twitter

Flask REST API For Pizza Delivery Service And Its Deployment To Heroku


Table of Contents
  1. About Flask REST API for Pizza Delivery Service
  2. What I learnt
  3. How to run the project on Local
  4. License
  5. Connect With Me
  6. Acknowledgements

back to top


About Flask REST API for Pizza Delivery Service

This is a GitHub repository for a Pizza Flask API that provides functionality for ordering pizzas from a hypothetical pizza delivery service.

The API provides several endpoints for various actions related to pizza ordering. Some of these endpoints include; sign up, login, place order, get all orders, delete order etc.

This Flask API could be a good starting point for someone looking to build a simple pizza ordering system or learn more about building APIs with Flask.

back to top

Built With:

Python Flask SQLite

Deployed With:

Heroku

back to top


What I learnt

  • How to set up a Flask API with Flask-RESTX
  • Databases with Flask-SQLAlchemy
  • JWT Authentication with Flask-JWT-Extended
  • Environment variables with Python-Decouple
  • Database migrations with Flask-Migrate
  • How to write Unit Tests with Unittest and PyTest
  • Documenting REST APIs with SwaggerUI and Flask-RESTX
  • Error Handling
  • Flask API Deployment via Heroku

back to top


How to run the project on Local

Clone the project Repository

git clone https://github.com/BrodaOJ56/flask-delivery-pizza-api/

Enter the project folder and create a virtual environment

$ cd https://github.com/BrodaOJ56/flask-delivery-pizza-api/

$ python -m venv env 

Activate the virtual environment

$ source env/bin/actvate #On linux Or Unix

$ source env/Scripts/activate #On Windows 
 

Install all requirements

$ pip install -r requirements.txt

Run the project in development

$ export FLASK_APP=api/
$ echo FLASK_APP
$ flask run

back to top


License

Distributed under the MIT License. See LICENSE for more information.

back to top


Connect With Me

OLUBUNMI OLUWATOBI JAMES - @ItzOfficialOJ

back to top


Acknowledgements

This project was made possible by:

back to top