Merge branch 'main' of https://github.com/call-0f-code/COC-API into Acheivements-Routes

Author: Sherin-2711

.github/workflows/apidocs.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up Bun
         uses: oven-sh/setup-bun@v2
         with:
-          bun-version: '1.2.18'    # or pin to whatever Bun version you need
+          bun-version: "1.2.18" # or pin to whatever Bun version you need
 
       - name: Cache Bun dependencies
         uses: actions/cache@v4
@@ -30,10 +30,9 @@ jobs:
 
       - name: Install dependencies
         run: bun install
-        
+
       - name: Generate Prisma client
         run: bun run generate
 
       - name: Run tests
         run: bun jest
-

.github/workflows/tests.yml

@@ -54,7 +54,7 @@ This repository contains the common Express.js API for the backends of our Codin
 │
 ├── tests/                   # integration and unit tests (Jest or Mocha)
 │   ├── members.test.ts
-│   └── ...  
+│   └── ...
 │
 ├── .env.example             # template for environment variables
 ├── package.json
@@ -65,7 +65,7 @@ This repository contains the common Express.js API for the backends of our Codin
 
 ### Prerequisite
 
-* Install [Bun](https://bun.sh/) on your machine.
+- Install [Bun](https://bun.sh/) on your machine.
 
 ### 1. Clone the repo
 
@@ -82,8 +82,8 @@ bun install
 
 ### 3. Configure environment
 
-* Copy `.env.example` to `.env`
-* Update `.env` with your Supabase/PostgreSQL connection URL and any other variables:
+- Copy `.env.example` to `.env`
+- Update `.env` with your Supabase/PostgreSQL connection URL and any other variables:
 
 ### 4. Initialize Prisma & Database
 
@@ -98,8 +98,8 @@ bun prisma generate
 bun run dev
 ```
 
-* By default, the server listens on `http://localhost:3000`
-* `app.ts` sets up your Express instance; `server.ts` starts the HTTP listener
+- By default, the server listens on `http://localhost:3000`
+- `app.ts` sets up your Express instance; `server.ts` starts the HTTP listener
 
 ### 6. Run tests
 

README.md

@@ -1,15 +1,15 @@
 {
-  "name":        "COC API",
-  "version":     "1.0.0",
+  "name": "COC API",
+  "version": "1.0.0",
   "description": "REST API for Coding Club backend",
-  "title":       "Coding Club API Docs",
+  "title": "Coding Club API Docs",
   "url": "http://localhost:3000/api/v1",
-  "sampleUrl":   false,
+  "sampleUrl": false,
   "template": {
     "withCompare": true,
     "sort": true
   },
-  "output":      "docs/apidoc",
-  "input":       "src/routes",        
-  "includeFilters": ["\\.ts$"]        
+  "output": "docs/apidoc",
+  "input": "src/routes",
+  "includeFilters": ["\\.ts$"]
 }

apidoc.json

@@ -3,9 +3,15 @@ import globals from "globals";
 import tseslint from "typescript-eslint";
 import { defineConfig } from "eslint/config";
 
-
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], plugins: { js }, extends: ["js/recommended"] },
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], languageOptions: { globals: globals.browser } },
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+  },
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    languageOptions: { globals: globals.browser },
+  },
   tseslint.configs.recommended,
 ]);

eslint.config.mjs

@@ -1 +1 @@
-console.log("Hello via Bun!");
+console.log("Hello via Bun!");

index.js

@@ -1,7 +1,6 @@
-
 export default {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  moduleFileExtensions: ['ts', 'js', 'json'],
-  testMatch: ['**/tests/**/*.test.ts'],
-}
+  preset: "ts-jest",
+  testEnvironment: "node",
+  moduleFileExtensions: ["ts", "js", "json"],
+  testMatch: ["**/tests/**/*.test.ts"],
+};

jest.config.ts

@@ -1,21 +1,20 @@
-import { mockDeep, mockReset, DeepMockProxy } from 'jest-mock-extended'
-import { PrismaClient } from '@prisma/client'
+import { mockDeep, mockReset, DeepMockProxy } from "jest-mock-extended";
+import { PrismaClient } from "@prisma/client";
 
-let mock: DeepMockProxy<PrismaClient>
+let mock: DeepMockProxy<PrismaClient>;
 
-jest.mock('./src/db/client', () => {
-  mock = mockDeep<PrismaClient>()
+jest.mock("./src/db/client", () => {
+  mock = mockDeep<PrismaClient>();
   return {
     __esModule: true,
     prisma: mock,
-  }
-})
+  };
+});
 
+import { prisma } from "./src/db/client";
 
-import { prisma } from './src/db/client'
-
-export const prismaMock = prisma as unknown as DeepMockProxy<PrismaClient>
+export const prismaMock = prisma as unknown as DeepMockProxy<PrismaClient>;
 
 beforeEach(() => {
-  mockReset(prismaMock)
-})
+  mockReset(prismaMock);
+});

singleton.ts

@@ -1,52 +1,53 @@
 // src/app.ts
-import express from 'express'
-import cors from 'cors'
-import multer from 'multer'
-import { json, urlencoded } from 'body-parser'
-import routes from './routes'
-import { errorHandler } from './utils/apiError'
-import { createClient } from '@supabase/supabase-js'
-import config from './config'
-import path from 'path'
-
+import express from "express";
+import cors from "cors";
+import multer from "multer";
+import { json, urlencoded } from "body-parser";
+import routes from "./routes";
+import { errorHandler } from "./utils/apiError";
+import { createClient } from "@supabase/supabase-js";
+import config from "./config";
+import path from "path";
 
 // Initialize Supabase client for storage operations
 export const supabase = createClient(
   config.SUPABASE_URL,
-  config.SUPABASE_SERVICE_ROLE_KEY
-)
+  config.SUPABASE_SERVICE_ROLE_KEY,
+);
 
-const app = express()
+const app = express();
 
 // 1) Enable CORS for your domains
-app.use(cors({
-  origin: config.ALLOWED_ORIGINS.split(','),  // e.g. 'https://club.example.com'
-  methods: ['GET','POST','PATCH','DELETE','OPTIONS'],
-  credentials: true,
-}))
+app.use(
+  cors({
+    origin: config.ALLOWED_ORIGINS.split(","), // e.g. 'https://club.example.com'
+    methods: ["GET", "POST", "PATCH", "DELETE", "OPTIONS"],
+    credentials: true,
+  }),
+);
 
 // 2) Parse JSON and form data
-app.use(json())
-app.use(urlencoded({ extended: true }))
+app.use(json());
+app.use(urlencoded({ extended: true }));
 
 // 3) Handle file uploads (in-memory)
-const upload = multer({ storage: multer.memoryStorage() })
+const upload = multer({ storage: multer.memoryStorage() });
 
 // 4) Mount your routes, injecting `upload` middleware where needed
 //    For endpoints that accept file uploads, you can do e.g.:
 //    router.post('/members/:memberId/photo', upload.single('photo'), ...)
 
-app.use('/api/v1', routes(upload, supabase))
+app.use("/api/v1", routes(upload, supabase));
 
 // 5) 404 handler
 app.use((req, res) => {
-  res.status(404).json({ message: 'Not Found' })
-})
+  res.status(404).json({ message: "Not Found" });
+});
 
 // 6) Global error handler
-app.use(errorHandler)
+app.use(errorHandler);
 
 // 7) do 'npm run apidoc to generate the documentation, I have added it in the scripts
 //    then you can go to localhost:3000/docs to see the docs
-app.use('/docs', express.static(path.join(__dirname, '..', 'docs/apidoc')))
-export default app
+app.use("/docs", express.static(path.join(__dirname, "..", "docs/apidoc")));
+export default app;

src/app.ts

@@ -4,5 +4,5 @@ export default {
   DIRECT_URL: process.env.DIRECT_URL!,
   SUPABASE_URL: process.env.SUPABASE_URL!,
   SUPABASE_SERVICE_ROLE_KEY: process.env.SUPABASE_SERVICE_ROLE_KEY!,
-  ALLOWED_ORIGINS: process.env.ALLOWED_ORIGINS || '*'
-}
+  ALLOWED_ORIGINS: process.env.ALLOWED_ORIGINS || "*",
+};