Revamp README: Add Badges, Modern Structure, and Clearer Onboarding

.github/workflows/docker-build.yml

@@ -0,0 +1,51 @@
+name: Docker Build and Test
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Build Backend
+      run: |
+        cd Backend
+        docker build -t inpactai-backend:test .
+
+    - name: Build Frontend
+      run: |
+        cd Frontend
+        docker build -t inpactai-frontend:test .
+
+    - name: Start services
+      run: |
+        docker compose up -d
+        sleep 30
+
+    - name: Check backend health
+      run: |
+        curl -f http://localhost:8000/ || exit 1
+
+    - name: Check frontend health
+      run: |
+        curl -f http://localhost:5173/ || exit 1
+
+    - name: Show logs on failure
+      if: failure()
+      run: |
+        docker compose logs
+
+    - name: Cleanup
+      if: always()
+      run: |
+        docker compose down -v

Backend/.dockerignore

@@ -0,0 +1,21 @@
+__pycache__
+*.pyc
+*.pyo
+*.pyd
+.Python
+*.so
+.env
+.venv
+env/
+venv/
+ENV/
+.git
+.gitignore
+.pytest_cache
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/
+.DS_Store
+*.log

Backend/.env.example

@@ -0,0 +1,12 @@
+user=postgres
+password=your_postgres_password
+host=your_postgres_host
+port=5432
+dbname=postgres
+GROQ_API_KEY=your_groq_api_key
+SUPABASE_URL=your_supabase_url
+SUPABASE_KEY=your_supabase_key
+GEMINI_API_KEY=your_gemini_api_key
+YOUTUBE_API_KEY=your_youtube_api_key
+REDIS_HOST=redis
+REDIS_PORT=6379

Backend/Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.10-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    libpq-dev \
+    curl \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+EXPOSE 8000
+
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000", "--reload"]

Backend/Dockerfile.prod

@@ -0,0 +1,33 @@
+FROM python:3.10-slim AS builder
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    libpq-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir --user -r requirements.txt
+
+FROM python:3.10-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    libpq5 \
+    && rm -rf /var/lib/apt/lists/* \
+    && groupadd -r appuser && useradd -r -g appuser appuser
+
+COPY --from=builder /root/.local /root/.local
+COPY . .
+
+RUN chown -R appuser:appuser /app
+
+USER appuser
+
+ENV PATH=/root/.local/bin:$PATH
+
+EXPOSE 8000
+
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]

Backend/app/main.py

@@ -44,7 +44,11 @@ async def lifespan(app: FastAPI):
 # Add CORS middleware
 app.add_middleware(
     CORSMiddleware,
-    allow_origins=["http://localhost:5173"],
+    allow_origins=[
+        "http://localhost:5173",
+        "http://frontend:5173",
+        "http://127.0.0.1:5173"
+    ],
     allow_credentials=True,
     allow_methods=["*"],
     allow_headers=["*"],

Backend/app/routes/post.py

@@ -18,25 +18,37 @@
 import uuid
 from datetime import datetime, timezone
 
-# Load environment variables
 load_dotenv()
-url: str = os.getenv("SUPABASE_URL")
-key: str = os.getenv("SUPABASE_KEY")
-supabase: Client = create_client(url, key)
+
+url: str = os.getenv("SUPABASE_URL", "")
+key: str = os.getenv("SUPABASE_KEY", "")
+
+if not url or not key or "your-" in url:
+    print("⚠️  Supabase credentials not configured. Some features will be limited.")
+    supabase = None
+else:
+    try:
+        supabase: Client = create_client(url, key)
+    except Exception as e:
+        print(f"❌ Supabase connection failed: {e}")
+        supabase = None
 
 # Define Router
 router = APIRouter()
 
-# Helper Functions
 def generate_uuid():
     return str(uuid.uuid4())
 
 def current_timestamp():
     return datetime.now(timezone.utc).isoformat()
 
-# ========== USER ROUTES ==========
+def check_supabase():
+    if not supabase:
+        raise HTTPException(status_code=503, detail="Database service unavailable. Please configure Supabase credentials.")
+
 @router.post("/users/")
 async def create_user(user: UserCreate):
+    check_supabase()
     user_id = generate_uuid()
     t = current_timestamp()
 

DOCKER-ARCHITECTURE.md

@@ -0,0 +1,175 @@
+# Docker Architecture Diagram
+
+```
+┌─────────────────────────────────────────────────────────────────────┐
+│                         Docker Host Machine                          │
+│                                                                       │
+│  ┌─────────────────────────────────────────────────────────────┐   │
+│  │                    Docker Network: inpactai-network          │   │
+│  │                                                               │   │
+│  │  ┌──────────────────┐    ┌──────────────────┐    ┌────────┐│   │
+│  │  │   Frontend       │    │   Backend        │    │ Redis  ││   │
+│  │  │   Container      │    │   Container      │    │ Container   │
+│  │  │                  │    │                  │    │        ││   │
+│  │  │  Node 18-alpine  │    │ Python 3.10-slim │    │ Redis 7││   │
+│  │  │  Vite Dev Server │◄───┤  FastAPI + uvicorn   │ Alpine ││   │
+│  │  │  Port: 5173      │    │  Port: 8000      │◄───┤ Port:  ││   │
+│  │  │                  │    │                  │    │ 6379   ││   │
+│  │  └──────────────────┘    └──────────────────┘    └────────┘│   │
+│  │         │                        │                     │    │   │
+│  │         │ Volume Mount           │ Volume Mount        │    │   │
+│  │         │ (Hot Reload)           │ (Hot Reload)        │    │   │
+│  │         ▼                        ▼                     ▼    │   │
+│  │  ┌──────────────┐        ┌─────────────┐      ┌──────────┐│   │
+│  │  │ ./Frontend   │        │ ./Backend   │      │redis_data││   │
+│  │  │ /app         │        │ /app        │      │  Volume  ││   │
+│  │  └──────────────┘        └─────────────┘      └──────────┘│   │
+│  └─────────────────────────────────────────────────────────────┘   │
+│                                                                       │
+│  Port Mappings:                                                      │
+│  ┌─────────────┬──────────────┬────────────────────────────────┐   │
+│  │ Host:5173   │ ──────────►  │ frontend:5173 (React + Vite)   │   │
+│  │ Host:8000   │ ──────────►  │ backend:8000  (FastAPI)        │   │
+│  │ Host:6379   │ ──────────►  │ redis:6379    (Cache)          │   │
+│  └─────────────┴──────────────┴────────────────────────────────┘   │
+│                                                                       │
+│  Environment Files:                                                  │
+│  ┌────────────────────────────────────────────────────────────┐    │
+│  │  Backend/.env  → Backend Container                          │    │
+│  │  Frontend/.env → Frontend Container                         │    │
+│  └────────────────────────────────────────────────────────────┘    │
+│                                                                       │
+└───────────────────────────────────────────────────────────────────────┘
+
+User Browser
+     │
+     ▼
+http://localhost:5173 ──► Frontend Container ──► React UI
+                                   │
+                                   │ API Calls
+                                   ▼
+                          http://backend:8000 ──► Backend Container ──► FastAPI
+                                                          │
+                                                          │ Cache/PubSub
+                                                          ▼
+                                                   redis:6379 ──► Redis Container
+
+
+Communication Flow:
+──────────────────────
+
+1. User accesses http://localhost:5173
+   └─► Docker routes to Frontend Container
+
+2. Frontend makes API call to /api/*
+   └─► Vite proxy forwards to http://backend:8000
+       └─► Docker network resolves 'backend' to Backend Container
+
+3. Backend connects to Redis
+   └─► Uses REDIS_HOST=redis environment variable
+       └─► Docker network resolves 'redis' to Redis Container
+
+4. Backend connects to Supabase
+   └─► Uses credentials from Backend/.env
+       └─► External connection via internet
+
+
+Service Dependencies:
+─────────────────────
+
+redis (no dependencies)
+   │
+   └─► backend (depends on redis)
+          │
+          └─► frontend (depends on backend)
+
+
+Health Checks:
+──────────────
+
+Redis:     redis-cli ping
+Backend:   curl http://localhost:8000/
+Frontend:  No health check (depends on backend health)
+
+
+Volume Mounts:
+──────────────
+
+Development:
+  ./Backend:/app              (Hot reload for Python)
+  ./Frontend:/app             (Hot reload for Vite)
+  /app/__pycache__            (Excluded)
+  /app/node_modules           (Excluded)
+
+Production:
+  redis_data:/data            (Persistent Redis storage only)
+
+
+Build Process:
+──────────────
+
+Development:
+  1. Copy package files
+  2. Install dependencies
+  3. Copy source code
+  4. Start dev server with hot reload
+
+Production:
+  Stage 1: Build
+    1. Copy package files
+    2. Install dependencies
+    3. Copy source code
+    4. Build optimized bundle
+
+  Stage 2: Serve
+    1. Copy built artifacts
+    2. Use minimal runtime (nginx for frontend)
+    3. Serve optimized files
+
+
+Network Isolation:
+──────────────────
+
+Internal Network (inpactai-network):
+  - frontend ←→ backend (HTTP)
+  - backend ←→ redis (TCP)
+
+External Access:
+  - Host machine → All containers (via port mapping)
+  - Backend → Supabase (via internet)
+  - Backend → External APIs (via internet)
+
+
+Security Model:
+───────────────
+
+Development:
+  - Root user in containers (for hot reload)
+  - Source code mounted as volumes
+  - Debug logging enabled
+
+Production:
+  - Non-root user in containers
+  - No volume mounts (except data)
+  - Production logging
+  - Resource limits enforced
+  - Optimized images
+```
+
+## Quick Command Reference
+
+```bash
+Start:     docker compose up --build
+Stop:      docker compose down
+Logs:      docker compose logs -f
+Rebuild:   docker compose up --build
+Clean:     docker compose down -v
+```
+
+## Service URLs
+
+| Service | Internal | External |
+|---------|----------|----------|
+| Frontend | frontend:5173 | http://localhost:5173 |
+| Backend | backend:8000 | http://localhost:8000 |
+| Redis | redis:6379 | localhost:6379 |