Recipe-API is a Django REST Framework application that provides a simple, robust API for managing recipes, ingredients, categories, and user interactions.
- CRUD operations for recipes, ingredients, and categories
- User authentication and permissions (JWT or Session Auth)
- Filtering, pagination, and search support
# Clone the repo
git clone https://github.com/your-org/recipe-api.git
cd recipe-api
# Install dependencies and activate environment
poetry install
poetry shell# Apply database migrations
poetry run python manage.py migrate
# Create a superuser for the admin interface
poetry run python manage.py createsuperuser
# Run the development server
poetry run python manage.py runserverOpen your web browser and navigate to:
http://localhost:8000/api/recipesto list all recipeshttp://localhost:8000/api/recipesto create a new recipehttp://localhost:8000/api/recipes/1to retrieve a single recipe
We use Poetry for dependency management and virtual environments.
- Install dependencies (including dev dependencies):
poetry install poetry shell
- Format & Lint:
poetry run black . && poetry run isort . && poetry run flake8 .
- Run tests:
poetry run pytest
Please read CONTRIBUTING.md for detailed guidelines on issues, pull requests, coding style, and testing.
This project is licensed under the MIT License. See LICENSE for details.