Basic Functional API

.env.example

@@ -0,0 +1,12 @@
+DATABASE_URL=
+SHADOW_DATABASE_URL=
+DB_HOST=
+DB_USER=
+DB_PASSWORD=
+DB_NAME=
+PORT=
+HOST=
+JWT_SECRET_KEY=
+ADMIN_SECRET_KEY=
+CORS_ORIGIN=
+NODE_ENV=

.github/workflows/test-ci.yml

@@ -0,0 +1,91 @@
+name: Test CI - Pull Request Validation
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Run Tests & Validate Coverage
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read # Required to checkout the code
+      issues: write # Required to create comments on PRs
+      pull-requests: write # Required to set commit statuses
+      statuses: write # Required to set commit statuses (often implicitly covered by pull-requests: write, but good to be explicit)
+    env:
+      # Dummy URL for init db in test CI
+      DATABASE_URL: mysql://root:password@localhost:3306/be_cms
+      SHADOW_DATABASE_URL: mysql://root:password@localhost:3306/shadow_be_cms
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with: 
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate Prisma Client
+        run: npm run gen
+
+      - name: Run tests with coverage
+        run: npm test -- --coverage --coverageReporters=json-summary --coverageReporters=text
+        continue-on-error: true
+
+      - name: Parse coverage and check threshold
+        id: coverage
+        run: |
+          # Read coverage.json and extract coverage percentage
+          COVERAGE=$(cat coverage/coverage-summary.json | jq '.total.lines.pct')
+          echo "coverage=$COVERAGE" >> $GITHUB_OUTPUT
+          echo "Coverage: $COVERAGE%"
+
+          # Check if coverage >= 70%
+          if (( $(echo "$COVERAGE >= 70" | bc -l) )); then
+            echo "✅ Coverage meets threshold (70%)"
+            echo "status=pass" >> $GITHUB_OUTPUT
+            exit 0
+          else
+            echo "❌ Coverage below threshold (70%)"
+            echo "status=fail" >> $GITHUB_OUTPUT
+            exit 1
+          fi
+        shell: bash
+
+      - name: Comment PR with test results
+        if: always()
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const coverage = '${{ steps.coverage.outputs.coverage }}';
+            const status = '${{ steps.coverage.outputs.status }}';
+
+            const icon = status === 'pass' ? '✅' : '❌';
+            const threshold = 70;
+
+            const comment = `## ${icon} Test Coverage Report
+
+            - **Coverage**: ${coverage}%
+            - **Threshold**: ${threshold}%
+            - **Status**: ${status === 'pass' ? 'PASS ✅ - Ready to merge' : 'FAIL ❌ - Coverage below threshold'}
+
+            ${status === 'pass' ? '**This PR can be merged!**' : '**Please improve test coverage to 70% or higher before merging.**'}
+            `;
+
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: comment
+            });
+
+      - name: Fail if coverage is below threshold
+        if: steps.coverage.outputs.status == 'fail'
+        run: exit 1

.gitignore

@@ -86,4 +86,8 @@ lerna-debug.log
 
 # System Files
 .DS_Store
-Thumbs.db
+Thumbs.db
+/src/generated/prisma
+
+#Additional
+stats.json

.prettierignore

@@ -0,0 +1,8 @@
+node_modules
+dist
+build
+prisma
+package-lock.json
+.env
+.env.example
+stats.json

.prettierrc

@@ -0,0 +1,8 @@
+{
+	"useTabs": true,
+	"tabWidth": 4,
+	"semi": true,
+	"singleQuote": true,
+	"trailingComma": "all",
+	"printWidth": 100
+}

admin.test.ts

@@ -0,0 +1,52 @@
+jest.mock('../service/stats.service', () => ({
+	getStats: jest.fn(),
+}));
+
+import request from 'supertest';
+import express from 'express';
+import * as StatsService from '../service/stats.service';
+
+const adminRouter = require('../routes/admin.route').default;
+
+const app = express();
+app.use(express.json());
+app.use('/admin', adminRouter);
+
+describe('Admin Controller - API Stats', () => {
+	const ADMIN_KEY = 'super-secret-admin-key';
+
+	beforeAll(() => {
+		process.env.ADMIN_SECRET_KEY = ADMIN_KEY;
+	});
+
+	beforeEach(() => {
+		jest.clearAllMocks();
+	});
+
+	it('should return 401 if x-admin-key header is missing', async () => {
+		const res = await request(app).get('/admin/stats');
+
+		expect(res.status).toBe(401);
+		expect(res.body.success).toBe(false);
+	});
+
+	it('should return 401 if x-admin-key is incorrect', async () => {
+		const res = await request(app).get('/admin/stats').set('x-admin-key', 'wrong-password-key');
+
+		expect(res.status).toBe(401);
+		expect(res.body.success).toBe(false);
+	});
+
+	it('should return 200 and statistics when x-admin-key is valid', async () => {
+		const mockStats = { 'GET /': 10, 'POST /login': 2 };
+		(StatsService.getStats as jest.Mock).mockReturnValue(mockStats);
+
+		const res = await request(app).get('/admin/stats').set('x-admin-key', ADMIN_KEY);
+
+		expect(res.status).toBe(200);
+		expect(res.body.success).toBe(true);
+		expect(res.body.message).toBe('Statistics retrieved successfully');
+		expect(res.body.data).toEqual(mockStats);
+		expect(StatsService.getStats).toHaveBeenCalledTimes(1);
+	});
+});

docs/req_res/auth.txt

@@ -0,0 +1,48 @@
+=== REGISTER
+/register
+POST
+body:
+{
+    "username": "user",
+    "password": "yourpassword"
+}
+response success:
+{
+    "success": true,
+    "message": "User registered successfully",
+    "data": {
+        "username": "user",
+        "createdAt": "2026-04-26T04:58:47.105Z",
+        "updatedAt": "2026-04-26T04:58:47.105Z"
+    }
+}
+response failed:
+{
+    "success": false,
+    "code": 409,
+    "message": "User already exists"
+}
+
+=== LOGIN
+/login
+POST
+body:
+{
+    "username": "user",
+    "password": "yourpassword"
+}
+response success:
+{
+    "success": true,
+    "message": "Login successful",
+    "data": {
+        "username": "user",
+        "token": "yourtoken"
+    }
+}
+response failed:
+{
+    "success": false,
+    "code": 401,
+    "message": "Invalid username or password"
+}