Skip to content
This repository has been archived by the owner on Dec 10, 2023. It is now read-only.
/ Pizza-Delivery-API Public archive

This is a REST API for a Pizza Delivery service built with FastAPI. Full playlist on Youtube

Notifications You must be signed in to change notification settings

jod35/Pizza-Delivery-API

Repository files navigation

PIZZA DELIVERY API

This is a REST API for a Pizza delivery service built for fun and learning with FastAPI, SQLAlchemy and PostgreSQL. The video playlist is here

ROUTES TO IMPLEMENT

METHOD ROUTE FUNCTIONALITY ACCESS
POST /auth/signup/ Register new user All users
POST /auth/login/ Login user All users
POST /orders/order/ Place an order All users
PUT /orders/order/update/{order_id}/ Update an order All users
PUT /orders/order/status/{order_id}/ Update order status Superuser
DELETE /orders/order/delete/{order_id}/ Delete/Remove an order All users
GET /orders/user/orders/ Get user's orders All users
GET /orders/orders/ List all orders made Superuser
GET /orders/orders/{order_id}/ Retrieve an order Superuser
GET /orders/user/order/{order_id}/ Get user's specific order
GET /docs/ View API documentation All users

How to run the Project

  • Install Postgreql
  • Install Python
  • Git clone the project with git clone https://github.com/jod35/Pizza-Delivery-API.git
  • Create your virtualenv with Pipenv or virtualenv and activate it.
  • Install the requirements with pip install -r requirements.txt
  • Set Up your PostgreSQL database and set its URI in your database.py
engine=create_engine('postgresql://postgres:<username>:<password>@localhost/<db_name>',
    echo=True
)
  • Create your database by running python init_db.py
  • Finally run the API ``` uvicorn main:app ``

About

This is a REST API for a Pizza Delivery service built with FastAPI. Full playlist on Youtube

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages