Skip to content

README.md

Latest commit

 

History

History
169 lines (116 loc) · 3.67 KB

README.md

File metadata and controls

169 lines (116 loc) · 3.67 KB

Django Tutorial using DRF and DRF Spectacular OpenAPI

Django DRF with SQLite, NGINX load balancing, and production-grade deployment setup.

Features:

  • Basic CRUD API for Employees and Department using Django DRF
  • Load balanced using NGINX
  • Deployed using Gunicorn Server
  • Multi-stage Docker builds for optimized images
  • Zstandard and Gzip compression
  • Health checks and automatic failover

Architecture

  • NGINX load balancer with 2 Django application replicas
  • Gunicorn as the WSGI server
  • Static files served by NGINX
  • Health monitoring and automatic failover
  • Session persistence using IP hash

Docker Compose Commands

Build and Run

# Enable BuildKit for optimized builds
$env:DOCKER_BUILDKIT=1

# Build and start all services
docker compose up --build -d

# Scale only web service
docker compose up -d --scale web=2

Container Management

# List running containers
docker compose ps

# View logs for specific service
docker compose logs -f web    # Django app logs
docker compose logs -f nginx  # NGINX logs

# Execute commands in container
docker compose exec web python manage.py migrate
docker compose exec web python manage.py collectstatic --noinput

# View logs with timestamps
docker compose logs --timestamps --tail=100

Health and Status

# Check health endpoint
curl http://localhost/health/

# Check NGINX status
docker compose exec nginx nginx -t

# View real-time container stats
docker compose top

Maintenance

# Stop all services
docker compose down

# Remove volumes (careful - this deletes data!)
docker compose down -v

# View container resource usage
docker stats

Configuration

Environment Variables

  • GUNICORN_WORKERS: Number of worker processes (default: 4)
  • GUNICORN_THREADS: Threads per worker (default: 2)
  • GUNICORN_MAX_REQUESTS: Max requests per worker (default: 1000)

NGINX Features

  • Load balancing (least connections + IP hash)
  • Zstandard and Gzip compression
  • Static file serving
  • Health checks
  • Rate limiting
  • Security headers

Security

  • Non-root container execution
  • Rate limiting
  • HTTP security headers
  • No build tools in production image

API Documentation

Access the API documentation at these endpoints:

Development

For local development without Docker:

# Install pipenv if you haven't already
pip install --user pipenv

# Install dependencies using Pipenv or uv
pipenv install

## UV commands to setup environment and run the project

> uv venv -p 3.13 --python-preference managed
> uv sync

## UV command to upgrade python and packages

> uv python upgrade
> uv sync --upgrade

## UV export to requirements.txt

> uv export --format=requirements.txt --all-packages > .\requirements.txt

# Activate the virtual environment
pipenv shell

# Run migrations
python manage.py migrate

# Start the development server
python manage.py runserver

Additional Development Commands

# Install a new package
pipenv install package_name

# Install development dependencies
pipenv install --dev

# Update all dependencies
pipenv update

# Generate requirements.txt (for Docker build)
pipenv requirements > requirements.txt
OR
uv export --format=requirements.txt --all-packages > .\requirements.txt

# Check security vulnerabilities
pipenv check

The project uses pyproject.toml, Pipfile and Pipfile.lock for dependency management, ensuring consistent environments across development machines.