This project provides a REST API for managing recipes. It allows users to create, read, update, and delete recipes, as well as tags and ingredients associated with each recipe. Additionally, users can filter, search, and sort recipes, and upload images for their recipes. The API is built using Python, Django, and Django REST framework, with a PostgreSQL database and Docker for containerization. The API documentation is available using Swagger. This project is open for contributions, and instructions for contributing are provided in the README file.
- User authentication (signup, login)
- Recipe CRUD (create, read, update, delete)
- Tag and Ingredient CRUD
- Filtering, searching and sorting recipes
- Image upload for recipes
- Python
- Django
- Django REST framework
- PostgreSQL
- Docker
NOTE: Please ensure that You have to install Docker and Docker Compose.
- Clone the repository to your local machine:
git clone https://github.com/codewithpradip/recipe-api.git- Start Container
docker compose up- The API documentation can be found at: http://127.0.0.1:8000/api/docs/
Feel free to to improve this project. If you have awesome ideas on your mind, please don't hesitate to open a pull request.
- Fork the repository.
- Create a new branch for your changes.
- Make your changes and commit them with a clear commit message.
- Push your branch to your forked repository.
- Create a pull request to merge your changes into the main repository.
NOTE: Please ensure that your code follows the existing style and passes all tests before submitting a pull request. Also, make sure to include a clear description of the changes you have made and why they are necessary.
Thank you for using checking this project. If you like this portfolio template don't forget give it a ⭐, it motivates me 😄.