https://github.com/roluochke/recipe-app-api
This full API service for your favorite recipes application is built using Python, Django, Django Rest Framework (DRF), PostgreSQL, and Docker, providing a comprehensive solution for managing and sharing your favorite recipes.
https://github.com/roluochke/recipe-app-api
django django-rest-framework docker postgresql python rest-api
Last synced: 2 months ago
JSON representation
This full API service for your favorite recipes application is built using Python, Django, Django Rest Framework (DRF), PostgreSQL, and Docker, providing a comprehensive solution for managing and sharing your favorite recipes.
- Host: GitHub
- URL: https://github.com/roluochke/recipe-app-api
- Owner: rOluochKe
- Created: 2023-04-04T08:25:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-23T10:12:26.000Z (about 3 years ago)
- Last Synced: 2025-02-05T21:00:57.292Z (over 1 year ago)
- Topics: django, django-rest-framework, docker, postgresql, python, rest-api
- Language: Python
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Recipe app API
This full API service for your favorite recipes application is built using Python, Django, Django Rest Framework (DRF), PostgreSQL, and Docker, providing a comprehensive solution for managing and sharing your favorite recipes.
Python serves as the core programming language, while Django offers a robust framework for developing web applications. DRF extends Django's capabilities, enabling the creation of powerful and flexible APIs for recipe management.
The PostgreSQL database ensures reliable and scalable data storage, allowing users to store and retrieve their favorite recipes efficiently.
By utilizing Docker, the application guarantees easy deployment and scalability, enabling seamless integration with existing infrastructure.
Through this API service, users can perform various recipe-related operations, such as creating, updating, and deleting recipes, as well as searching and filtering recipes based on different criteria.
The combination of Python, Django, DRF, PostgreSQL, and Docker empowers users to create a customized and user-friendly recipe application, enabling them to share and explore their favorite recipes with ease.
## Technologies
- Python
- Django
- Django Rest Framework
- PostgreSQL
- Docker
- Unittest
## Setup
### Dev Environment
- Build `docker-compose build`
- Run app `docker-compose up`
- Docker down `docker-compose down`
- Lint `docker-compose run --rm app sh -c "python manage.py wait_for_db && flake8"`
- Tests `docker-compose run --rm app sh -c "python manage.py wait_for_db && python manage.py test"`
- Make migrations `docker-compose run --rm app sh -c "python manage.py wait_for_db && python manage.py makemigrations"`
- Run migrate `docker-compose run --rm app sh -c "python manage.py wait_for_db && python manage.py migrate"`
- Create super user `docker-compose run --rm app sh -c "python manage.py wait_for_db && python manage.py createsuperuser"`
### Deploy
- Down `docker-compose -f docker-compose-deploy.yml down`
- Run `docker-compose -f docker-compose-deploy.yml up`
### Updating app
- Volume down `docker-compose down --volumes`