Merge pull request #8 from omidcodes/008-fix-deployment-and-docker-compose

Add Nginx reverse proxy & fix docker-compose

Author: omidcodes

Dockerfile

@@ -10,7 +10,7 @@ WORKDIR /app
 
 # Install dependencies
 COPY requirements.txt .
-RUN pip install --upgrade pip && pip install -r requirements.txt
+RUN pip install --upgrade pip && pip install -r requirements.txt && apt-get install -y netcat
 
 # Copy project files
 COPY . .

README.md

@@ -1,39 +1,40 @@
-
 # 🧩 TaskFlow API
 
-A Django RESTful API for managing personal or team tasks — featuring PostgreSQL, RabbitMQ, Docker support, and developer/production-ready configurations.
+A Django RESTful API for managing personal or team tasks — featuring PostgreSQL, RabbitMQ, Celery, and Nginx in a Dockerized production setup.
 
 ---
 
 ## 🚀 Features
 
 - ✅ Django 5 + Django REST Framework
-- ✅ PostgreSQL database (via Docker)
-- ✅ RabbitMQ for background tasks (Celery integrated)
-- ✅ Asynchronous task logging using Celery
+- ✅ PostgreSQL database (Dockerized)
+- ✅ RabbitMQ for background tasks (Celery-integrated)
+- ✅ Celery task queue for async logging
+- ✅ Gunicorn for WSGI-based production serving
+- ✅ Nginx reverse proxy for HTTP routing and static file delivery
 - ✅ Environment config with `.env` and `python-decouple`
 - ✅ Swagger UI for API documentation
-- ✅ Containerized with Docker
-- ✅ CLI scripts for development and production modes
-- ✅ Pytest-based testing with coverage
+- ✅ Docker & Docker Compose for development and deployment
+- ✅ Pytest-based testing with coverage reporting
 
 ---
 
 ## 📁 Project Structure
 
 ```
 taskflow-api/
-├── taskflow_api/           # Django project (includes celery.py)
-├── tasks/                  # App: task models, views, serializers, signals, celery tasks
-├── tests/                  # Pytest tests for models, API, celery tasks
+├── taskflow_api/           # Django project (with celery.py)
+├── tasks/                  # App: models, views, serializers, signals, celery tasks
+├── tests/                  # Pytest tests for models, views, celery
+├── Dockerfile              # Docker image for Django (Gunicorn inside)
+├── docker-compose.yml      # Full stack (Django, DB, Celery, Nginx, RabbitMQ)
+├── nginx.conf              # Nginx config for reverse proxy
+├── .env                    # Environment variables
+├── logs/                   # Log folder (created if missing)
 ├── requirements.txt        # Python dependencies
-├── Dockerfile              # Production image for gunicorn
-├── docker-compose.yml      # DB and RabbitMQ container setup
-├── .env                    # Environment configuration
-├── logs/                   # Directory for activity logs (auto-created)
-├── run_server.sh           # Run production server (Gunicorn)
-├── start-dev-services.sh   # Run DB + RabbitMQ for development
-├── lint-clean.sh           # Ruff lint & formatting script
+├── run_server.sh           # Start all services in production mode
+├── start-dev-services.sh   # Run only DB & RabbitMQ for local development
+├── lint-clean.sh           # Format & lint Python code using Ruff
 └── pytest.ini              # Pytest configuration
 ```
 
@@ -43,21 +44,21 @@ taskflow-api/
 
 - Python 3.12+
 - Docker & Docker Compose
-- Virtualenv (optional but recommended)
+- (Optional) Virtualenv for local development
 
 ---
 
 ## 📦 Setup Instructions
 
-### 🔧 1. Install Python Dependencies
+### 🔧 1. Create Virtual Environment (Optional)
 ```bash
 python3 -m venv env
 source env/bin/activate
 pip install -r requirements.txt
 ```
 
 ### 🔧 2. Configure Environment
-Edit `.env` (already provided):
+Edit the `.env` file:
 ```dotenv
 DEBUG=True
 SECRET_KEY=your-secret-key
@@ -74,101 +75,100 @@ CELERY_BROKER_URL=amqp://guest:guest@localhost:5672//
 
 ---
 
-## 🧪 Development Mode
+## 🧪 Development Mode (Local Python)
 
-Use this when you want to run Django locally (`runserver`) and containers only for DB/RabbitMQ.
+Run Django and Celery locally. Use Docker for DB & RabbitMQ only.
 
-### ▶️ Start Docker Services:
 ```bash
-./start-dev-services.sh
+./start-dev-services.sh      # Start db + rabbitmq only
+python manage.py runserver   # Run Django locally
+celery -A taskflow_api worker --loglevel=info  # Start Celery
 ```
 
-> This will:
-> - Start PostgreSQL and RabbitMQ containers
-> - Stop and remove any running web container
-> - Run DB migrations automatically
-
-### ▶️ Then Run Django:
-```bash
-python3 manage.py runserver
-```
-
-### ▶️ Run Celery Worker:
-```bash
-celery -A taskflow_api worker --loglevel=info
-```
-
-Open:
-- Swagger docs: http://localhost:8000/docs/
-- API root: http://localhost:8000/api/tasks/
+> Local URLs:
+> - API: http://localhost:8000/api/tasks/
+> - Docs: http://localhost:8000/docs/
 
 ---
 
-## 🧪 Run Tests and Coverage
+## 🧪 Run Tests
 
 ### ▶️ Run all tests
 ```bash
 pytest
 ```
 
-### ▶️ Run tests **with coverage** (after installing `pytest-cov`)
+### ▶️ With coverage
 ```bash
 pytest --cov=. --cov-report=term-missing
 ```
 
-### ▶️ (Optional) Generate HTML coverage report
+### ▶️ (Optional) HTML Coverage Report
 ```bash
 pytest --cov=. --cov-report=html
 # Open htmlcov/index.html in your browser
 ```
 
 ---
 
-## 🧩 Celery Logging Task
-
-When a task is created through the API, a Celery worker will automatically:
+## 🧩 Celery Background Logging
 
-- Run `log_task_action` in the background using `celery -A taskflow_api worker --loglevel=info`
-- Write an entry like this to `logs/task_activity.log`:
+When a task is created via API, a background task (`log_task_action`) is triggered:
 
+- Logs to `logs/task_activity.log`
+- Format:
 ```
 [2025-09-14 19:45:00] Task #12 ('Example Task') was created via Celery background task.
 ```
 
 ---
 
-## 🏭 Production Mode (Dockerized Web)
+## 🏭 Production Mode (Dockerized Full Stack)
 
-### ▶️ Build & Run All Services:
+### ▶️ Start All Services
 ```bash
 ./run_server.sh
 ```
 
-> This uses Docker to run:
-> - Django (with Gunicorn)
-> - PostgreSQL
-> - RabbitMQ
+This command will:
+- Build the Docker image
+- Run Django with Gunicorn
+- Serve via Nginx on port `80`
+- Collect static files into a volume
+- Expose the full app on http://localhost/
 
-You can also run manually:
+> Alternatively:
 ```bash
 docker compose up --build
 ```
 
 ---
 
+## 🌐 Accessing App
+
+- Web App: [http://localhost/](http://localhost/)
+- API: [http://localhost/api/tasks/](http://localhost/api/tasks/)
+- Swagger Docs: [http://localhost/docs/](http://localhost/docs/)
+- RabbitMQ UI: [http://localhost:15672](http://localhost:15672) (user/pass: guest/guest)
+
+---
+
 ## 🗃️ Tech Stack
 
-- **Backend**: Django 5, DRF
-- **Database**: PostgreSQL (Docker)
-- **Broker**: RabbitMQ (Docker)
-- **Background Jobs**: Celery (activity logging)
-- **Containerization**: Docker, Docker Compose
-- **Testing**: Pytest, pytest-django, pytest-cov
-- **Linting**: Ruff
-- **CI-ready**: Gunicorn + environment-based config
+| Layer         | Tech                    |
+|---------------|-------------------------|
+| Backend       | Django 5 + DRF          |
+| Database      | PostgreSQL              |
+| Broker        | RabbitMQ                |
+| Async Tasks   | Celery                  |
+| Server        | Gunicorn + Nginx        |
+| Containers    | Docker Compose          |
+| Testing       | Pytest + pytest-cov     |
+| Linting       | Ruff                    |
+| Deployment    | Shell scripts + volumes |
 
 ---
 
 ## 📜 License
 
-MIT © Omid Hashemzadeh
+MIT © Omid Hashemzadeh

docker-compose.yml

@@ -1,21 +1,32 @@
+version: '3.9'
+
 services:
   web:
     build: .
     command: /entrypoint.sh
     volumes:
       - .:/app
-    ports:
-      - "8000:8000"
+      - static_volume:/app/staticfiles
+    expose:
+      - "8000"  # Internal, not published to host
     depends_on:
       - db
       - rabbitmq
     env_file:
       - .env
     environment:
-      # Useful if override needed, else .env handles it
       POSTGRES_HOST: db
       CELERY_BROKER_URL: amqp://guest:guest@rabbitmq:5672//
 
+  nginx:
+    image: nginx:alpine
+    ports:
+      - "80:80"
+    depends_on:
+      - web
+    volumes:
+      - static_volume:/usr/share/nginx/html/static
+      - ./nginx.conf:/etc/nginx/nginx.conf:ro
 
   db:
     image: postgres
@@ -42,6 +53,8 @@ services:
     env_file:
       - .env
     environment:
-      # Useful if override needed, else .env handles it
       POSTGRES_HOST: db
       CELERY_BROKER_URL: amqp://guest:guest@rabbitmq:5672//
+
+volumes:
+  static_volume:

entrypoint.sh

@@ -1,7 +1,18 @@
 #!/bin/bash
 
+
+# Wait for PostgreSQL to be ready
+echo "⏳ Waiting for Postgres..."
+until nc -z $POSTGRES_HOST 5432; do
+  sleep 1
+done
+echo "✅ Postgres is up!"
+
 echo "🚀 Running migrations..."
 python manage.py migrate
 
+echo "📦 Collecting static files..."
+python manage.py collectstatic --noinput
+
 echo "🚀 Starting Gunicorn..."
-exec gunicorn taskflow_api.wsgi:application --bind 0.0.0.0:8000
+exec gunicorn taskflow_api.wsgi:application --bind 0.0.0.0:8000 --timeout 120

nginx.conf

@@ -0,0 +1,31 @@
+worker_processes 1;
+events { worker_connections 1024; }
+
+http {
+    include       mime.types;
+    default_type  application/octet-stream;
+
+    sendfile        on;
+    keepalive_timeout 65;
+
+    upstream django {
+        server web:8000;
+    }
+
+    server {
+        listen 80;
+        server_name localhost;
+
+        location /static/ {
+            alias /usr/share/nginx/html/static/;
+        }
+
+        location / {
+            proxy_pass http://django;
+            proxy_set_header Host $host;
+            proxy_set_header X-Real-IP $remote_addr;
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_set_header X-Forwarded-Proto $scheme;
+        }
+    }
+}

taskflow_api/settings.py

@@ -1,5 +1,6 @@
 from pathlib import Path
 from decouple import config, Csv
+import os
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
@@ -90,6 +91,7 @@
 # https://docs.djangoproject.com/en/5.2/howto/static-files/
 
 STATIC_URL = "static/"
+STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field

taskflow_api/urls.py

@@ -3,6 +3,9 @@
 from rest_framework import permissions
 from drf_yasg.views import get_schema_view
 from drf_yasg import openapi
+from django.conf import settings
+
+from tasks.views import home_view
 
 schema_view = get_schema_view(
     openapi.Info(
@@ -23,3 +26,7 @@
         name="schema-swagger-ui",
     ),
 ]
+
+if settings.DEBUG == "FALSE":
+    # production home page
+    urlpatterns.append(path("", home_view))

tasks/tests/test_api.py

@@ -3,13 +3,18 @@
 from django.urls import reverse
 from datetime import date
 
+
 @pytest.mark.django_db
 def test_create_task_api():
     client = APIClient()
     url = reverse("task-list")  # Adjust if you use a different route name
-    response = client.post(url, {
-        "title": "API Task",
-        "due_date": date.today(),
-    }, format="json")
+    response = client.post(
+        url,
+        {
+            "title": "API Task",
+            "due_date": date.today(),
+        },
+        format="json",
+    )
     assert response.status_code == 201
     assert response.data["title"] == "API Task"