https://github.com/jod35/pizza-delivery-api-django

This is a REST API for a Pizza delivery service implemented with Django.
https://github.com/jod35/pizza-delivery-api-django

django django-rest-framework heroku postgresql

Last synced: about 2 months ago
JSON representation

This is a REST API for a Pizza delivery service implemented with Django.

• Host: GitHub
• URL: https://github.com/jod35/pizza-delivery-api-django
• Owner: jod35
• Created: 2021-10-04T15:57:30.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-05T06:14:23.000Z (about 3 years ago)
• Last Synced: 2023-03-05T14:03:17.440Z (almost 2 years ago)
• Topics: django, django-rest-framework, heroku, postgresql
• Language: JavaScript
• Homepage:
• Size: 4.32 MB
• Stars: 13
• Watchers: 1
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## 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](https://www.youtube.com/playlist?list=PLEt8Tae2spYnLMAf8RGCNYhovIFZHVsPP)

## ROUTES TO IMPLEMENT

| METHOD | ROUTE | FUNCTIONALITY |ACCESS|

| ------- | ----- | ------------- | ------------- |

| *POST* | ```/auth/signup/``` | _Register new user_| _All users_|

| *POST* | ```/auth/jwt/create/``` | _Login user_|_All users_|

| *POST* | ```/auth/jwt/refresh/``` | _Refresh the access token_|_All users_|

| *POST* | ```/auth/jwt/verify/``` | _Verify the validity of a token_|_All users_|

| *POST* | ```/orders/``` | _Place an order_|_All users_|

| *POST* | ```/orders/``` | _Get all orders_|_All users_|

| *GET* | ```/order/{order_id}/``` | _Retrieve an order_|_Superuser_|

| *PUT* | ```/orders/{order_id}/``` | _Update an order_|_All users_|

| *PUT* | ```/update-status/{order_id}/``` | _Update order status_|_Superuser_|

| *DELETE* | ```/delete/{order_id}/``` | _Delete/Remove an order_ |_All users_|

| *GET* | ```/user/{user_id}/orders/``` | _Get user's orders_|_All users_|

| *GET* | ```/user/{user_id}/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 ```

- Create you database with `python manage.py runserver` 

- Finally run the API 

``` python manage.py runserver ``