Merge pull request #214 from Chigybillionz/Add-Docker-Compose

[DevOps] Add Docker Compose for local development

Author: jobbykings

DEVELOPMENT.md

@@ -0,0 +1,48 @@
+# Local Development Guide
+
+This guide explains how to set up the StarkEd project for local development using Docker Compose.
+
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+
+## Services overview
+
+The `docker-compose.yml` file sets up the following services:
+- **backend**: Node.js backend API (Port: 5000)
+- **frontend**: Next.js frontend (Port: 3000)
+- **postgres**: PostgreSQL database (Port: 5432)
+- **redis**: Redis cache (Port: 6379)
+- **ipfs**: IPFS node for decentralized storage (Ports: 4001, 5001, 8080)
+
+## Getting Started
+
+1. **Start all services**:
+   ```bash
+   docker compose up -d --build
+   ```
+
+2. **Seed the database**:
+   Once the containers are running and healthy, run the migrations and seed the database with initial development data:
+   ```bash
+   bash scripts/seed-dev.sh
+   ```
+
+## Hot Reloading
+
+Both the backend and frontend are configured with volume mounts. Changes you make to the source code on your host machine will be immediately reflected inside the running containers, triggering a hot reload for Next.js (frontend) and nodemon (backend).
+
+## Health Checks
+
+All containers are equipped with health checks. You can check the status of your services by running:
+```bash
+docker compose ps
+```
+
+## Clean Environment
+
+If you need to wipe all data (database, redis, ipfs) and start fresh, run:
+```bash
+docker compose down --volumes --remove-orphans
+```

backend/Dockerfile.dev

@@ -0,0 +1,8 @@
+FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+RUN npm install
+
+CMD ["npm", "run", "dev"]

backend/package.json

@@ -13,6 +13,7 @@
     "migrate:up": "ts-node src/utils/migrate.ts up",
     "migrate:down": "ts-node src/utils/migrate.ts down",
     "migrate:status": "ts-node src/utils/migrate.ts status",
+    "seed": "ts-node src/utils/seed.ts",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",

backend/src/utils/seed.ts

@@ -0,0 +1,44 @@
+import { Pool } from 'pg';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+const pool = new Pool({
+  host: process.env.DB_HOST || 'localhost',
+  port: parseInt(process.env.DB_PORT || '5432', 10),
+  user: process.env.DB_USER || 'postgres',
+  password: process.env.DB_PASSWORD || 'postgres',
+  database: process.env.DB_NAME || 'starked_dev'
+});
+
+async function runSeed() {
+  const client = await pool.connect();
+  try {
+    console.log('Seeding development data...');
+    // Create users table if not exists
+    await client.query(`
+      CREATE TABLE IF NOT EXISTS users (
+        id SERIAL PRIMARY KEY,
+        email VARCHAR(255) UNIQUE NOT NULL,
+        name VARCHAR(255) NOT NULL,
+        created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+      )
+    `);
+
+    // Insert dummy user
+    await client.query(`
+      INSERT INTO users (email, name)
+      VALUES ('admin@starked.edu', 'Admin User')
+      ON CONFLICT (email) DO NOTHING
+    `);
+
+    console.log('Development data seeded successfully.');
+  } catch (error) {
+    console.error('Error seeding data:', error);
+  } finally {
+    client.release();
+    await pool.end();
+  }
+}
+
+runSeed();

docker-compose.yml

@@ -0,0 +1,103 @@
+version: '3.8'
+
+services:
+  backend:
+    build:
+      context: ./backend
+      dockerfile: Dockerfile.dev
+    ports:
+      - "5000:5000"
+    volumes:
+      - ./backend:/app
+      - /app/node_modules
+    environment:
+      - NODE_ENV=development
+      - PORT=5000
+      - DB_HOST=postgres
+      - DB_PORT=5432
+      - DB_USER=postgres
+      - DB_PASSWORD=postgres
+      - DB_NAME=starked_dev
+      - REDIS_URL=redis://redis:6379
+      - IPFS_URL=http://ipfs:5001
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+    healthcheck:
+      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:5000/api/health"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 30s
+
+  frontend:
+    build:
+      context: ./frontend
+      dockerfile: Dockerfile.dev
+    ports:
+      - "3000:3000"
+    volumes:
+      - ./frontend:/app
+      - /app/node_modules
+      - /app/.next
+    environment:
+      - NODE_ENV=development
+      - NEXT_PUBLIC_API_URL=http://localhost:5000/api
+    depends_on:
+      - backend
+    healthcheck:
+      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:3000"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 30s
+
+  postgres:
+    image: postgres:15
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_DB=starked_dev
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres -d starked_dev"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
+  redis:
+    image: redis:7
+    ports:
+      - "6379:6379"
+    volumes:
+      - redis_data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
+  ipfs:
+    image: ipfs/kubo:latest
+    ports:
+      - "4001:4001"
+      - "5001:5001"
+      - "8080:8080"
+    volumes:
+      - ipfs_data:/data/ipfs
+    healthcheck:
+      test: ["CMD", "ipfs", "diag", "cmds"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 20s
+
+volumes:
+  postgres_data:
+  redis_data:
+  ipfs_data:

frontend/Dockerfile.dev

@@ -0,0 +1,8 @@
+FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+RUN npm install
+
+CMD ["npm", "run", "dev"]

scripts/seed-dev.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+set -e
+
+echo "Starting development seed process..."
+
+# Ensure backend container is running
+if ! docker compose ps | grep -q backend; then
+    echo "Backend container is not running. Please run 'docker compose up -d' first."
+    exit 1
+fi
+
+echo "Running database migrations..."
+docker compose exec backend npm run migrate:up
+
+echo "Running database seed..."
+docker compose exec backend npm run seed
+
+echo "Database seeded successfully!"