https://github.com/dotpep/restaurant-api

Restaurant API using DRF, with Authentication, Menu, Cart and Order management systems and etc.
https://github.com/dotpep/restaurant-api

api django django-rest-framework drf functional-programming python restaurant

Last synced: 3 days ago
JSON representation

Restaurant API using DRF, with Authentication, Menu, Cart and Order management systems and etc.

• Host: GitHub
• URL: https://github.com/dotpep/restaurant-api
• Owner: dotpep
• License: mit
• Created: 2024-01-11T11:30:57.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-01-22T21:37:15.000Z (10 months ago)
• Last Synced: 2024-02-14T11:26:26.082Z (9 months ago)
• Topics: api, django, django-rest-framework, drf, functional-programming, python, restaurant
• Language: Python
• Homepage:
• Size: 355 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Restaurant API

This is project that provide rest api and system management for Restaurant.

## API Features

- Authentication

- Searching, Filtering, Ordering/Sorting

- Pagination and Throttling

- Category

- Menu Item

- User group management

- Cart management

- Order management

Groups/Roles: Admin, Manager, Delivery crew, authenticated user is Customer

## Installation and Runing

- clone this repo `git clone https://github.com/dotpep/restaurant-api`

- `cd restaurant-api`

- insatall `python` > 3.8

- install pipenv for virtual environment `pip insatall pipenv`

- create virtual enviroment `pipenv shell`

- install dependencies `pipenv install`

- `python manage.py runserver`

You should now be able to access the API at `http://localhost:8000/`

Admin panel `http://localhost:8000/admin/`

username: admin

password: admin

- you can activate pipenv venv in powershell by `pipenv shell`, `&.virtualenvs\restaurant-api-your_specific_project_hash\Scripts\activate.sh`

- Check python version `pip --version` or Use pyenv to install multiple python version `pip install pyenv`

- Verify that all dependencies are installed correctly `pipenv graph`

- models `python manage.py makemigrations` and `python manage.py migrate`

Use requiremetns.txt and standard venv instead pipenv

- `python venv env`

- `env\Scripts\activate`

- `pip install -r requiremets.txt`

## Documentation

### Demonstration

### API

you can find Insomnia API endpoints testing collection in path `docs/API`:

- [Testing Endpoints Collection in Insomnia (click me to see it)](docs/API)

### ER-diagram

path to ER-D `docs/ERD/README.md`

- [Entity Relation Diagram of Django Models (click me to see it)](docs/ERD/README.md)

![Database Entity Design ER-D](docs/ERD/ER-D_restaurantapi.png)

## LICENCE

This project is licensed under the [MIT License](LICENSE).