Develop

.github/workflows/main.yml

@@ -0,0 +1,129 @@
+name: Main Foodgram workflow
+
+on: push
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:13.10
+        env:
+          POSTGRES_USER: foodgram_user
+          POSTGRES_PASSWORD: foodgram_password
+          POSTGRES_DB: foodgram_db
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip 
+        pip install flake8==6.0.0
+        pip install -r ./backend/requirements.txt 
+    - name: Test with flake8 and django tests
+      env:
+        POSTGRES_USER: foodgram_user
+        POSTGRES_PASSWORD: foodgram_password
+        POSTGRES_DB: foodgram_db
+        DB_HOST: 127.0.0.1
+        DB_PORT: 5432
+      run: |
+        python -m flake8 backend/
+        cd backend/
+        python manage.py test
+
+
+  build_backend_and_push_to_docker_hub:
+    name: Push Backend Docker image to DockerHub
+    runs-on: ubuntu-latest
+    needs: tests 
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to Docker 
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Push to DockerHub
+        uses: docker/build-push-action@v4
+        with:
+          context: ./backend/
+          push: true
+          tags: ${{ secrets.DOCKER_USERNAME }}/foodgram_backend:latest 
+
+  build_frontend_and_push_to_docker_hub:
+    name: Push frontend Docker image to DockerHub
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to Docker 
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Push to DockerHub
+        uses: docker/build-push-action@v4
+        with:
+          context: ./frontend/
+          push: true
+          tags: ${{ secrets.DOCKER_USERNAME }}/foodgram_frontend:latest
+
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: 
+      - build_backend_and_push_to_docker_hub
+      - build_frontend_and_push_to_docker_hub
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v3
+    - name: Copy docker-compose.yml via ssh
+      uses: appleboy/scp-action@master
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USER }}
+        key: ${{ secrets.SSH_KEY }}
+        passphrase: ${{ secrets.SSH_PASSPHRASE }}
+        source: "docker-compose.production.yml"
+        target: "foodgram"
+    - name: Executing remote ssh commands to deploy
+      uses: appleboy/ssh-action@master
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USER }}
+        key: ${{ secrets.SSH_KEY }}
+        passphrase: ${{ secrets.SSH_PASSPHRASE }}
+        script: |
+          cd foodgram
+          sudo docker compose -f docker-compose.production.yml pull
+          sudo docker compose -f docker-compose.production.yml down
+          sudo docker compose -f docker-compose.production.yml up -d
+          sudo docker compose -f docker-compose.production.yml exec backend python manage.py migrate
+          sudo docker compose -f docker-compose.production.yml exec backend python manage.py collectstatic
+          sudo docker compose -f docker-compose.production.yml exec backend cp -r /app/collected_static/. /backend_static/static/
+
+
+  send_message:
+    runs-on: ubuntu-latest
+    needs: deploy
+    steps:
+    - name: Send message
+      uses: appleboy/telegram-action@master
+      with:
+        to: ${{ secrets.TELEGRAM_TO }}
+        token: ${{ secrets.TELEGRAM_TOKEN }}
+        message: Деплой успешно выполнен! https://github.com/${{ github.repository }}/commit/${{github.sha}}

README.md

@@ -1 +1,95 @@
-# praktikum_new_diplom
+
+# Foodgram
+Проект "Продуктовый помошник" (Foodgram) — сайт с рецептами.
+
+## Технологии:
+Python 3.9
+Django 3.2.3
+djangorestframework 3.12.4
+Nginx
+gunicorn
+Docker
+
+## Описание работы:
+В проекте "Проуктовый помощник" любители вкусно готовить могут публиковать рецепты, добавлять чужие рецепты в избранное и подписываться на публикации других авторов. Пользователям сайта также будет доступен сервис «Список покупок». Он позволит создавать список продуктов, которые нужно купить для приготовления выбранных блюд.
+
+## Установка проекта
+- Сделайте fork репозитория, затем клонируйте его:
+```
+git clone https://github.com/ZebraHr/foodgram-project-reactl
+```
+- Для адаптации проекта на своем удаленном сервере добавьте секреты в GitHub Actions:
+```
+DOCKER_USERNAME                # имя пользователя в DockerHub
+DOCKER_PASSWORD                # пароль пользователя в DockerHub
+HOST                           # ip_address сервера
+USER                           # имя пользователя
+SSH_KEY                        # приватный ssh-ключ (cat ~/.ssh/id_rsa)
+SSH_PASSPHRASE                 # кодовая фраза (пароль) для ssh-ключа
+
+TELEGRAM_TO                    # id телеграм-аккаунта (можно узнать у @userinfobot, команда /start)
+TELEGRAM_TOKEN                 # токен бота (получить токен можно у @BotFather, /token, имя бота)
+```
+- На удаленном сервере создайте папку foodgram/
+- На удаленном сервере в папке проекта cоздайте файл .env:
+```
+POSTGRES_DB=<Желаемое_имя_базы_данных>
+POSTGRES_USER=<Желаемое_имя_пользователя_базы_данных>
+POSTGRES_PASSWORD=<Желаемый_пароль_пользователя_базы_данных>
+DB_HOST=db
+DB_PORT=5432
+
+SECRET_KEY = 'ваш_secret_key'
+ALLOWED_HOSTS = ip_удаленного сервера, 127.0.0.1, localhost
+DEBUG = False
+```
+- Установка Nginx. Находясь на удалённом сервере, из любой директории выполните команду, затем запустите Nginx:
+```
+sudo apt install nginx -y 
+sudo systemctl start nginx
+```
+- Перейдите в файл конфигурации nginx и измените его настройки на следующие:
+```
+nano /etc/nginx/sites-enabled/default
+```
+```
+server {
+    server_name server_name <публичный-IP-адрес> <доменное-имя>;
+    server_tokens_off;
+    client_max_body_size 30M;
+
+    location / {
+        proxy_set_header Host $http_host;
+        proxy_pass http://127.0.0.1:8000;
+    }
+
+}
+```
+- Перезарузите Nginx:
+```
+sudo nginx -t
+sudo systemctl reload nginx
+```
+- Откройте порты для фаервола и активируйте его:
+```
+sudo ufw allow 'Nginx Full'
+sudo ufw allow OpenSSH
+sudo ufw enable
+```
+- (Опционально) Получите SSL-сертификат для вашего доменного имени с помощью Certbot:
+```
+sudo apt install snapd
+sudo snap install core; sudo snap refresh core
+sudo snap install --classic certbot
+sudo ln -s /snap/bin/certbot /usr/bin/certbot 
+sudo certbot --nginx
+```
+- Пуш в любую ветку запускает тестирование и деплой Foodgram на ваш удаленный сервер, а после успешного деплоя вам приходит оповещение в телеграм.
+
+### Автор
+Анна Победоносцева
+
+Студент Яндекс Практикума ["Python-разаботчик плюс"](https://practicum.yandex.ru/python-developer-plus/?from=catalog)
+
+GitHub:
+(https://github.com/ZebraHr)

backend/.dockerignore

@@ -0,0 +1,6 @@
+venv
+.git
+db.sqlite3
+.idea
+.vscode
+.env

backend/Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.9
+
+WORKDIR /app
+
+COPY requirements.txt ./
+
+RUN pip install -r requirements.txt --no-cache-dir
+
+COPY . .
+
+CMD ["gunicorn", "--bind", "0.0.0.0:8000", "foodgram.wsgi"]

backend/api/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'api'

backend/api/filters.py

@@ -0,0 +1,53 @@
+from django_filters.rest_framework import filters, FilterSet
+from recipes.models import Recipe, Ingredient
+from users.models import User
+
+
+class IngredientFilter(FilterSet):
+    name = filters.CharFilter(lookup_expr='istartswith')
+
+    class Meta:
+        model = Ingredient
+        fields = ('name',)
+
+
+IN_NOT_IN = (
+    (0, 'Not_In'),
+    (1, 'In'),
+)
+
+
+class RecipeFilter(FilterSet):
+    """Фильтрация рецептов."""
+
+    author = filters.ModelChoiceFilter(
+        queryset=User.objects.all()
+    )
+    is_in_shopping_cart = filters.ChoiceFilter(
+        choices=IN_NOT_IN, method='get_is_in'
+    )
+    is_favorited = filters.ChoiceFilter(
+        choices=IN_NOT_IN,
+        method='get_is_in'
+    )
+    tags = filters.AllValuesMultipleFilter(
+        field_name='tags__slug',
+        label='Ссылка'
+    )
+
+    def get_is_in(self, queryset, name, value):
+        """
+        Фильтрация рецептов по избранному и списку покупок.
+        """
+        user = self.request.user
+        if user.is_authenticated:
+            if value == '1':
+                if name == 'is_favorited':
+                    queryset = queryset.filter(favorites_recipes__user=user)
+                if name == 'is_in_shopping_cart':
+                    queryset = queryset.filter(shopping_cart__user=user)
+        return queryset
+
+    class Meta:
+        model = Recipe
+        fields = ['is_favorited', 'is_in_shopping_cart', 'author', 'tags']

backend/api/paginations.py

@@ -0,0 +1,7 @@
+from rest_framework.pagination import PageNumberPagination
+
+
+class RecipePagination(PageNumberPagination):
+    """Паджинация рецептов."""
+    page_size = 6
+    page_size_query_param = 'limit'

backend/api/permissions.py

@@ -0,0 +1,20 @@
+from rest_framework.permissions import SAFE_METHODS, BasePermission
+
+
+class IsOwnerOrReadOnly(BasePermission):
+    def has_object_permission(self, request, view, obj):
+        return request.method in SAFE_METHODS or obj.author == request.user
+
+
+class IsAmdinOrReadOnly(BasePermission):
+
+    def has_permission(self, request, view):
+        return (request.method in SAFE_METHODS
+                or (
+                    request.user.is_authenticated
+                    and (request.user.is_admin or request.user.is_superuser)))
+
+# class IsAdminOrReadOnly(BasePermission):
+#     def has_permission(self, request, view):
+#         return (request.method in SAFE_METHODS
+#                 or request.user and request.user.is_staff)