Merge pull request #82 from HazarBakir/main

feat(docker): dockerize app with dev compose and docs

Author: ArjinAlbay

.dockerignore

@@ -0,0 +1,13 @@
+node_modules
+.next
+out
+.git
+.gitignore
+Dockerfile*
+docker-compose*.yml
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-store
+.env*
+**/*.tsbuildinfo

Dockerfile

@@ -0,0 +1,44 @@
+# syntax=docker/dockerfile:1.7
+
+# ---------- Base ----------
+FROM node:20-alpine AS base
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+WORKDIR /app
+
+# ---------- Deps (install with frozen lockfile) ----------
+FROM base AS deps
+RUN apk add --no-cache libc6-compat
+COPY package.json package-lock.json ./
+RUN npm ci
+
+# ---------- Build ----------
+FROM base AS build
+ENV NEXT_TELEMETRY_DISABLED=1
+# Provide a safe default so NextAuth doesn't fail during build
+ENV NEXTAUTH_SECRET=dev_docker_build_secret
+RUN apk add --no-cache libc6-compat
+COPY --from=deps /app/node_modules ./node_modules
+COPY . .
+RUN npm run build
+
+# ---------- Runtime ----------
+FROM node:20-alpine AS runner
+ENV NODE_ENV=production
+WORKDIR /app
+
+# Non-root user
+RUN addgroup -S nextjs && adduser -S nextjs -G nextjs
+
+# Copy standalone server
+COPY --from=build /app/.next/standalone ./
+COPY --from=build /app/.next/static ./.next/static
+COPY --from=build /app/public ./public
+
+ENV PORT=3000
+ENV HOSTNAME=0.0.0.0
+EXPOSE 3000
+USER nextjs
+
+CMD ["node", "server.js"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 HappyHackingSpace
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -137,4 +137,40 @@ Contributions are welcome! Please open an issue or submit a pull request.
 
 ## License
 
-MIT  
+MIT  
+
+## Docker
+
+### Development (hot reload)
+```bash
+# Start dev container (no image build needed)
+docker compose -f docker-compose.dev.yml up
+# Then open http://localhost:3000
+```
+- Create `.env.local` in the project root with at least:
+```bash
+NEXTAUTH_SECRET=your_secure_secret
+NEXTAUTH_URL=http://localhost:3000
+GITHUB_CLIENT_ID=your_client_id
+GITHUB_CLIENT_SECRET=your_client_secret
+```
+- Code changes on your host are reflected inside the container.
+- Uses bind mounts and `npm run dev`.
+
+### Production
+```bash
+# Build image and start
+docker compose up --build -d
+# Tail logs
+docker compose logs -f
+# Stop
+docker compose down
+```
+Set required environment variables (can be .env file in project root):
+```bash
+NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_SECRET=replace_with_secure_random
+GITHUB_CLIENT_ID=your_client_id
+GITHUB_CLIENT_SECRET=your_client_secret
+```
+Note: a default `NEXTAUTH_SECRET` is set only during the image build to allow Next.js to compile. You must provide real secrets at runtime via `.env` or your deployment platform.  

docker-compose.dev.yml

@@ -0,0 +1,16 @@
+services:
+  web:
+    image: node:20-alpine
+    working_dir: /app
+    command: sh -c "npm ci && npm run dev"
+    ports:
+      - "3000:3000"
+    environment:
+      - NODE_ENV=development
+      - NEXT_TELEMETRY_DISABLED=1
+      - HOSTNAME=0.0.0.0
+    volumes:
+      - ./:/app
+      - /app/node_modules
+      - /app/.next
+    restart: unless-stopped

docker-compose.yml

@@ -0,0 +1,19 @@
+services:
+  web:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: runner
+    image: githubmon:prod
+    ports:
+      - "3000:3000"
+    environment:
+      - NODE_ENV=production
+      - NEXT_TELEMETRY_DISABLED=1
+      - HOSTNAME=0.0.0.0
+      # Map your envs; you can also use an env_file
+      - NEXTAUTH_URL=${NEXTAUTH_URL}
+      - NEXTAUTH_SECRET=${NEXTAUTH_SECRET}
+      - GITHUB_CLIENT_ID=${GITHUB_CLIENT_ID}
+      - GITHUB_CLIENT_SECRET=${GITHUB_CLIENT_SECRET}
+    restart: unless-stopped

package-lock.json

@@ -1,7 +1,6 @@
 'use client'
 
 import { useRouter } from 'next/navigation'
-import { Badge } from '@/components/ui/badge'
 import { RateLimitWarning } from '@/components/common/RateLimitWarning'
 import { ThemeToggle } from '@/components/theme/ThemeToggle'
 import { useSearchStore } from '@/stores'