In this service, users can authorize, publish recipes, subscribe to the publication of other users, create a list of favorite, form a shopping list, and download this list. After registration users get an authorization token. To add recipes, users should choose ingredients from the base and tags(for example Breakfast), amount, add image, text, and cooking time, all fields are required.
In the repository exist the next directories: frontend, backend, infra(configuration file nginx and docker-compose.yml), data(ingredients file) and docs.
Additionally configured CI/CD(Continuous Integration and Continuous Deployment) for this project:
- automatic start of tests(pep8),
- building or updating the docker image in the container on Docker Hub;
- automatic deployment to the production server;
- Python 3.8
- Django 4.1
- Django Rest Framework
- Djoser + TokenAuthentication
- PostreSQL
- Nginx
- Gunicorn
- Docker
Clone project from:
[email protected]:lanazzk/foodgram-project-react.git
Install and activate virtual environment. Then go to:
cd /infra
Start up projet by running :
docker-compose up
Need to create file .env in directory /foodgram/foodgram Sample of env-file located in /foodgram/foodgram .env.example
Run next commands in rotation:
docker compose exec backend python manage.py makemigrations
docker compose exec web python manage.py migrate
docker compose exec web python manage.py createsuperuser
docker compose exec web python manage.py collectstatic --no-input
POST /api/users/
{
"email": "[email protected]",
"username": "vasya.pupkin",
"first_name": "Вася",
"last_name": "Пупкин",
"password": "Qwerty123"
}
POST auth/token/
{
"password": "string",
"email": "string"
}
{
"auth_token": "string"
}Update recipe
Access permission: Only author or administrator.
PATH http://localhost/api/recipes/{id}/
json
{
"ingredients": [
{
"id": 1123,
"amount": 10
}
],
"tags": [
1,
2
],
"image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAgMAAABieywaAAAACVBMVEUAAAD///9fX1/S0ecCAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAACklEQVQImWNoAAAAggCByxOyYQAAAABJRU5ErkJggg==",
"name": "string",
"text": "string",
"cooking_time": 1
}
Get all recipes
Access permission: Any. Available without registration
GET /api/recipes
{
"count": 123,
"next": "http://foodgram.example.org/api/recipes/?page=4",
"previous": "http://foodgram.example.org/api/recipes/?page=2",
"results": [
{
"id": 0,
"tags": [
{
"id": 0,
"name": "Завтрак",
"color": "#E26C2D",
"slug": "breakfast"
}
],
"author": {
"email": "[email protected]",
"id": 0,
"username": "string",
"first_name": "Вася",
"last_name": "Пупкин",
"is_subscribed": false
},
"ingredients": [
{
"id": 0,
"name": "Картофель отварной",
"measurement_unit": "г",
"amount": 1
}
],
"is_favorited": true,
"is_in_shopping_cart": true,
"name": "string",
"image": "http://foodgram.example.org/media/recipes/images/image.jpeg",
"text": "string",
"cooking_time": 1
}
]
}
Add recipe in "Favorite"
Access permission: Authenticated users
POST /api/recipes/{id}/favorite/
{
"id": 0,
"name": "string",
"image": "http://foodgram.example.org/media/recipes/images/image.jpeg",
"cooking_time": 1
}
}
Screenshots:
