Merge pull request #3 from omidcodes/003-add-readme-file

Add Readme.md file
Seperate development and production bash scripts

Author: omidcodes

.env.example

@@ -0,0 +1,13 @@
+# development env
+
+DEBUG=True
+SECRET_KEY=your-secret-key-for-dev
+DJANGO_ALLOWED_HOSTS=localhost,127.0.0.1,[::1]
+
+POSTGRES_DB=taskflow
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+
+CELERY_BROKER_URL=amqp://guest:guest@localhost:5672//

Dockerfile

@@ -14,8 +14,10 @@ RUN pip install --upgrade pip && pip install -r requirements.txt
 
 # Copy project files
 COPY . .
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
 
 # Collect static files (optional if using admin panel)
 RUN mkdir -p /vol/web/static
 
-CMD ["gunicorn", "taskflow_api.wsgi:application", "--bind", "0.0.0.0:8000"]
+CMD ["/entrypoint.sh"]

README.md

@@ -0,0 +1,127 @@
+
+# 🧩 TaskFlow API
+
+A Django RESTful API for managing personal or team tasks — featuring PostgreSQL, RabbitMQ, Docker support, and developer/production-ready configurations.
+
+---
+
+## 🚀 Features
+
+- ✅ Django 5 + Django REST Framework
+- ✅ PostgreSQL database (via Docker)
+- ✅ RabbitMQ for background tasks (Celery-ready)
+- ✅ Environment config with `.env` and `python-decouple`
+- ✅ Swagger UI for API documentation
+- ✅ Containerized with Docker
+- ✅ CLI scripts for development and production modes
+
+---
+
+## 📁 Project Structure
+
+```
+taskflow-api/
+├── taskflow_api/           # Django project
+├── tasks/                  # App: task models, views, serializers
+├── requirements.txt        # Python dependencies
+├── Dockerfile              # Production image for gunicorn
+├── docker-compose.yml      # DB and RabbitMQ container setup
+├── .env                    # Environment configuration
+├── run_server.sh           # Run production server (Gunicorn)
+└── start-dev-services.sh   # Run DB + RabbitMQ for development
+```
+
+---
+
+## ⚙️ Prerequisites
+
+- Python 3.12+
+- Docker & Docker Compose
+- Virtualenv (optional but recommended)
+
+---
+
+## 📦 Setup Instructions
+
+### 🔧 1. Install Python Dependencies
+```bash
+python3 -m venv env
+source env/bin/activate
+pip install -r requirements.txt
+```
+
+### 🔧 2. Configure Environment
+Edit `.env` (already provided):
+```dotenv
+DEBUG=True
+SECRET_KEY=your-secret-key
+DJANGO_ALLOWED_HOSTS=localhost,127.0.0.1,[::1]
+
+POSTGRES_DB=taskflow
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+
+CELERY_BROKER_URL=amqp://guest:guest@localhost:5672//
+```
+
+---
+
+## 🧪 Development Mode
+
+Use this when you want to run Django locally (`runserver`) and containers only for DB/RabbitMQ.
+
+### ▶️ Start Docker Services:
+```bash
+./start-dev-services.sh
+```
+
+> 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
+```
+
+Open:
+- Swagger docs: http://localhost:8000/docs/
+- API root: http://localhost:8000/api/tasks/
+
+---
+
+## 🏭 Production Mode (Dockerized Web)
+
+### ▶️ Build & Run All Services:
+```bash
+./run_server.sh
+```
+
+> This uses Docker to run:
+> - Django (with Gunicorn)
+> - PostgreSQL
+> - RabbitMQ
+
+You can also run manually:
+```bash
+docker compose up --build
+```
+
+---
+
+## 🗃️ Tech Stack
+
+- **Backend**: Django 5, DRF
+- **Database**: PostgreSQL (Docker)
+- **Broker**: RabbitMQ (Docker)
+- **Containerization**: Docker, Docker Compose
+- **CI-ready**: Gunicorn + environment-based config
+
+---
+
+## 📜 License
+
+MIT © Omid Hashemzadeh

docker-compose.yml

@@ -1,30 +1,24 @@
 services:
   web:
     build: .
-    command: gunicorn taskflow_api.wsgi:application --bind 0.0.0.0:8000
+    command: /entrypoint.sh
     volumes:
       - .:/app
     ports:
       - "8000:8000"
     depends_on:
       - db
       - rabbitmq
+    env_file:
+      - .env
     environment:
-      - DEBUG=1
-      - DJANGO_SETTINGS_MODULE=taskflow_api.settings
-      - POSTGRES_DB=taskflow
-      - POSTGRES_USER=postgres
-      - POSTGRES_PASSWORD=postgres
-      - POSTGRES_HOST=db
-      - POSTGRES_PORT=5432
+      POSTGRES_HOST: db
 
   db:
     image: postgres
     restart: always
-    environment:
-      POSTGRES_DB: taskflow
-      POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: postgres
+    env_file:
+      - .env
     ports:
       - "5432:5432"
 

entrypoint.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+echo "🚀 Running migrations..."
+python manage.py migrate
+
+echo "🚀 Starting Gunicorn..."
+exec gunicorn taskflow_api.wsgi:application --bind 0.0.0.0:8000

requirements.txt

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 docker compose down
 docker compose build --no-cache
 docker compose up

run_server.sh

@@ -118,9 +118,9 @@
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.postgresql',
-        'NAME': config('POSTGRES_DB', default='taskflow'),
-        'USER': config('POSTGRES_USER', default='postgres'),
-        'PASSWORD': config('POSTGRES_PASSWORD', default='postgres'),
+        'NAME': config('POSTGRES_DB'),
+        'USER': config('POSTGRES_USER'),
+        'PASSWORD': config('POSTGRES_PASSWORD'),
         'HOST': config('POSTGRES_HOST', default='localhost'),
         'PORT': config('POSTGRES_PORT', default='5432'),
     }