https://github.com/4kauanmota/food-api
https://github.com/4kauanmota/food-api
flask poetry python
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/4kauanmota/food-api
- Owner: 4kauanmota
- Created: 2023-12-20T21:32:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T22:00:35.000Z (over 2 years ago)
- Last Synced: 2025-06-13T05:44:50.437Z (about 1 year ago)
- Topics: flask, poetry, python
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
 
# 📄 **Informations**
**This is my first python api project, and had the help of this video :)**
+ https://www.youtube.com/watch?v=1_nQ5A2HcgU (rest api in python)
---
# ✨ **Features**
+ CRUD
+ Food
+ GET (with filter), POST, PUT, DELETE, GET BY ID
---
# 💻 **Technologies**
+ [PYTHON](https://www.python.org/)
+ [POETRY](https://python-poetry.org/)
+ [FLASK](https://flask.palletsprojects.com/en/3.0.x/)
+ [VISUAL STUDIO CODE](https://code.visualstudio.com/)
---
# ⚙️ **How to run**
### Requirements
+ [PYTHON](https://www.python.org/)
+ [POETRY](https://python-poetry.org/)
### Codes
+ `git clone https://github.com/4kauanmota/food-API .`
+ `poetry shell`
+ `poetry install`
+ `flask run`
### Cloning project
First you will need to open the terminal in the folder where you want to clone this project, and then, you paste this code
```
git clone https://github.com/4kauanmota/food-API .
```
### Getting into the virtual environment
In the project folder terminal you should enter
```
poetry shell
```
to enter in the virtual enviroment
### Installing dependencies
After that you should enter
```
poetry install
```
to install project depedencies
### Running project
To run the project you just need to enter
```
flask run
```
---
# 👀 **Preview**
### Desktop
##### Swagger
https://imgur.com/a/qVRQe38
---
# 📝 **Author**
[Kauan Soares Mota](https://github.com/4kauanmota)