cicd

Author: Witkovskyy

.dockerignore

@@ -0,0 +1,14 @@
+node_modules
+.next
+dist
+.git
+.github
+Dockerfile
+.dockerignore
+npm-debug.log
+docker-compose.override.yml
+env.*
+backups
+.vscode
+.cache
+*.tgz

.gitattributes

@@ -0,0 +1,46 @@
+# Default: treat files as text and normalize to LF
+* text=auto eol=lf
+
+# Explicit rules for common text file types (ensure LF)
+.gitattributes text eol=lf
+*.md text eol=lf
+*.markdown text eol=lf
+*.json text eol=lf
+*.yml text eol=lf
+*.yaml text eol=lf
+*.toml text eol=lf
+*.xml text eol=lf
+*.html text eol=lf
+*.htm text eol=lf
+*.js text eol=lf
+*.jsx text eol=lf
+*.ts text eol=lf
+*.tsx text eol=lf
+*.css text eol=lf
+*.scss text eol=lf
+*.less text eol=lf
+*.json5 text eol=lf
+*.jsonc text eol=lf
+*.sh text eol=lf
+*.ps1 text eol=lf
+*.bat text eol=lf
+*.mdx text eol=lf
+
+# Mark typical binary files so Git doesn't attempt line-ending conversions
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.webp binary
+*.zip binary
+*.gz binary
+*.tar.gz binary
+*.tgz binary
+*.pdf binary
+*.woff binary
+*.woff2 binary
+*.eot binary
+*.ttf binary
+
+# end

.github/workflows/ci.yml

@@ -0,0 +1,149 @@
+name: CI - split: lint, generate, build, migrate, push
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch: {}
+
+env:
+  # Default image name (override by setting the secret IMAGE_NAME to e.g. 'username/repo')
+  IMAGE: ${{ secrets.IMAGE_NAME || github.repository }}
+
+jobs:
+  lint:
+    name: lint + pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Cache npm
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run lint (eslint)
+        run: npm run lint
+
+      - name: Run pre-commit (lint-staged)
+        # lint-staged expects staged files; --allow-empty prevents failure when none are staged in CI
+        run: npx lint-staged --allow-empty --verbose
+
+  generate:
+    name: prisma:generate
+    runs-on: ubuntu-latest
+    needs: lint
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Cache npm
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Prisma generate (produce client binaries)
+        run: npx prisma generate
+
+  build:
+    name: build image
+    runs-on: ubuntu-latest
+    needs: generate
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build image (local cache, do not push)
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./Dockerfile
+          push: false
+          tags: ${{ env.IMAGE }}:${{ github.sha }}
+
+  migrate:
+    name: optional: prisma migrate deploy
+    runs-on: ubuntu-latest
+    needs: build
+    if: ${{ secrets.DATABASE_URL }}
+    env:
+      DATABASE_URL: ${{ secrets.DATABASE_URL }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Cache npm
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Prisma migrate deploy
+        run: npx prisma migrate deploy
+
+  push:
+    name: optional: docker push
+    runs-on: ubuntu-latest
+    needs: build
+    if: ${{ secrets.DOCKERHUB_USERNAME && secrets.DOCKERHUB_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Login to Docker registry
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Push image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ${{ env.IMAGE }}:${{ github.sha }}
+            ${{ env.IMAGE }}:latest
+
+  done-notify:
+    name: done
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - name: Done
+        run: echo "CI finished. Image: $IMAGE (pushed if credentials provided)"

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# Run lint-staged (configured in package.json)
+npx --no-install lint-staged

Dockerfile

@@ -0,0 +1,29 @@
+FROM node:20-bullseye-slim AS deps
+WORKDIR /app
+# Install system deps needed by some native modules (sharp, etc.)
+RUN apt-get update && apt-get install -y --no-install-recommends build-essential python3 && rm -rf /var/lib/apt/lists/*
+
+# Copy package manifests and install deps first so Docker layer cache helps on rebuilds
+COPY package.json package-lock.json* ./
+RUN npm ci --ignore-scripts --no-audit --no-fund || npm install --no-audit --no-fund
+
+FROM node:20-bullseye-slim AS base
+WORKDIR /app
+COPY --from=deps /app/node_modules ./node_modules
+COPY . .
+
+FROM base AS dev
+ENV NODE_ENV=development
+EXPOSE 3000
+CMD ["sh", "-c", "npm run dev"]
+
+FROM base AS build
+ENV NODE_ENV=production
+RUN npm run build
+
+FROM node:20-bullseye-slim AS prod
+WORKDIR /app
+COPY --from=build /app .
+ENV NODE_ENV=production
+EXPOSE 3000
+CMD ["sh", "-c", "npm run start"]

README.md

@@ -1,26 +1,75 @@
 This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
 
-## Getting Started
+# Getting started
 
-First, prepare the development server:
+Requirements
+- Docker & Docker Compose
+- PowerShell (commands below use PowerShell syntax)
 
-```bash
-npx prisma generate
+Quick start:
+
+```powershell
+# Run all services, install dependencies and apply migrations
+docker compose up --build
 ```
 
-Then run the dev server:
+Open http://localhost:3000 to see the results.
 
-```bash
-npm run dev
+
+Services one by one start:
+
+1) Apply migrations (one-off):
+
+```powershell
+# Run the migrate service: installs dependencies and runs 'npx prisma migrate deploy'
+docker compose -f .\docker-compose.yml run --rm migrate
+```
+
+2) Start the app and database in the background:
+
+```powershell
+docker compose -f .\docker-compose.yml up -d
 ```
 
-Open [http://localhost:3000](http://localhost:3000) to see the results.
+3) Tail app logs:
+
+```powershell
+docker compose -f .\docker-compose.yml logs --follow --tail 200 app
+```
 
+Useful commands
 
+```powershell
+# Check service status
+docker compose -f .\docker-compose.yml ps
 
-## The project features so far
+# Run migrate manually (one-off / CI)
+docker compose -f .\docker-compose.yml run --rm migrate
+
+# List tables in the Postgres database
+docker compose -f .\docker-compose.yml exec postgres psql -U admin -d boardsy -c "\dt"
+
+# Stop and remove containers and volumes (including node_modules volume)
+docker compose -f .\docker-compose.yml down --volumes
+```
 
-Below is a directory graph of the actual project structure under `src/`, followed by a breakdown of each route and its Server Actions:
+Why there is a `migrate` service?
+
+- The `migrate` service is a one-off container that installs project dependencies and runs `npx prisma migrate deploy` against the database running in Compose. This avoids running migrations manually on the host.
+- After migrations finish, the `migrate` container exits. This is expected.
+
+About `node_modules` and Windows
+
+- We use a named Docker volume for `node_modules` to avoid common Windows <-> container filesystem issues (for example, `ENOTEMPTY` errors during `npm install`). If something goes wrong, you can remove the volume with `docker compose down --volumes` and restart.
+
+Troubleshooting (common issues)
+
+- Can't reach database (`P1001` / "Can't reach database server at localhost:5432"): make sure services use the internal Compose hostname `postgres`. The compose file in this repo sets `LOCAL_DATABASE_URL` for `app` and `migrate` to use the `postgres` service.
+- `ENOTEMPTY` during `npm install` in the container: handled by using a named `node_modules` volume. If it persists, remove that volume and retry.
+
+Open http://localhost:3000 to see the results.
+
+## Project structure (high level)
 
 ```bash
 src/
@@ -46,13 +95,3 @@ src/
 └─ types/
    └─ global.d.ts    # Global type declarations
 ```
-
-
-
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-* [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-* [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.