Skip to content

README.md

Latest commit

 

History

History
128 lines (91 loc) · 6.95 KB

README.md

File metadata and controls

128 lines (91 loc) · 6.95 KB
Raw

Foodgram

Python Django DRF Flake8 NodeJS HTML5 CSS PostgreSQL JWT Redoc Postman Nginx Docker GitHub Actions Markdown PowerShell Git

About

Grocery Assistant: a service for publishing recipes, adding them to favorites, subscribing to authors and generating a consolidated shopping list with the ability to download to PDF.

Project links

Author of the project

  • Egor Briliov | Backend Developer
  • Telegram | @briliov

Tech Stack & Infrastructure

  • Backend: Python 3.12, Django 6.1, Django REST Framework (DRF), Djoser.
  • Database: PostgreSQL 15 (Production) / SQLite (Local Development).
  • Frontend: React (SPA application; the container is used for static building).
  • WSGI & Web Server: Gunicorn, Nginx.
  • Containerization: Docker, Docker Compose (Separate dev/prod configuration environments).
  • CI/CD: GitHub Actions (Two independent workflow automation setups, Docker Hub, and Telegram API integration).
  • Code Quality: Verified with Flake8 linter adhering strictly to PEP 8 standards.

The application is deployed on a virtual private server inside four isolated containers: nginx, db (PostgreSQL), backend, and frontend. Persistent data stores, media, and static assets are managed using Docker Volumes.

How to install & Deploy

Local Development Setup

  1. Clone the repository:
bash
git clone https://github.com/nexordon/foodgram.git
cd foodgram
  1. Configure environment variables:

Create a .env file in the root directory (where your development docker-compose.yml file is located):

env
SECRET_KEY=your_secure_django_secret_key
DEBUG=True
ALLOWED_HOSTS=127.0.0.1,localhost
  1. Launch the local infrastructure using Docker:

Build and start the multi-container development environment:

docker compose up -d --build

Note: In development mode (target: development), the backend container automatically performs database migrations (makemigrations && migrate), loads core system fixtures (load_data), and runs collectstatic before starting the built-in development server.

  1. Verify execution:

The application will be accessible via standard interfaces through the Nginx gateway on port :80. You can monitor log execution streams using:

docker compose logs -f backend

CI/CD Workflow & Production Deployment

The project features fully automated staging and deployment layers controlled by GitHub Actions via distinct workflow routines.

1. Automation Architecture & Required Secrets

To enable automated validations and delivery, make sure to provision the following environmental variables within your GitHub Repository settings (Settings -> Secrets and variables -> Actions):

  • DOCKER_USERNAME / DOCKER_PASSWORD — Shared keys needed to publish images to DockerHub.
  • HOST / USER / SSH_KEY — Remote Linux parameters targeted by deployment workflows.
  • TELEGRAM_TO / TELEGRAM_TOKEN — Credentials required to deliver operational push alerts.

2. Workflow Lifecycles

  • Development Workflow (dev.yml): Automatically triggers on any push to the dev branch. It hosts an isolated postgres:13.10 runner to perform code evaluation assertions (ruff check) and execute tests (python manage.py test).

  • Main Deployment Workflow (main.yml): Automatically runs on any push to the main branch. It manages the following sequence:

    1. Runs code quality assertions and tests.

    2. Compiles production assets and pushes verified Docker images (backend and frontend) directly to your DockerHub space (nexordon/foodgram_backend:latest, nexordon/foodgram_frontend:latest).

    3. Copies the production compose definitions (infra/docker-compose.production.yml) and web server setup configs (infra/nginx.conf) to the remote hosting environment over SSH.

    4. Automatically handles deployment updates on the remote server:

      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 container exec foodgram-backend python manage.py migrate
sudo docker container exec foodgram-backend python manage.py collectstatic --no-input

      In the production environment, the backend server operates securely via a managed Gunicorn WSGI server binding on internal port :8000, while the custom Nginx templates route traffic and serve static files.

    5. Dispatches an operational delivery diagnostic summary straight to the configured Telegram endpoint.

Testing & Debugging Details

  • API Functional Testing: The workspace contains preconfigured operational templates available inside the postman_collection/ directory to run automated tracking assertions using Postman.
  • Reviewer Remote Infrastructure Access: Connection strings and server access parameters required to inspect operations on active staging layers are located inside the tests.yml configuration mapping file (login, password, vm_name).