https://github.com/chaganti-reddy/pizza-delivery-fastapi

Pizza Delivery API Using FastAPI
https://github.com/chaganti-reddy/pizza-delivery-fastapi

fastap orm python3 sqlalchemy

Last synced: 8 days ago
JSON representation

Pizza Delivery API Using FastAPI

• Host: GitHub
• URL: https://github.com/chaganti-reddy/pizza-delivery-fastapi
• Owner: Chaganti-Reddy
• License: mit
• Created: 2024-03-18T05:44:44.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-18T05:48:02.000Z (11 months ago)
• Last Synced: 2024-03-18T06:43:27.298Z (11 months ago)
• Topics: fastap, orm, python3, sqlalchemy
• Language: Python
• Homepage:
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## PIZZA DELIVERY API

This is a FastAPI for a Pizza delivery service built for learning the FastAPI, SQLAlchemy and PostgreSQL.

## 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/Chaganti-Reddy/Pizza-Delivery-FastAPI.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::@localhost/',

    echo=True

)

```

- Create your database by running ``` python init_db.py ```

- Finally run the API

``` uvicorn main:app ``