Merge pull request #39 from call-0f-code/health-endpoint

Refactor routes and improve error handling; added health check endpoint; and removed comments

Author: Sherin-2711

src/app.ts

@@ -1,4 +1,3 @@
-// src/app.ts
 import express from "express";
 import cors from "cors";
 import multer from "multer";
@@ -17,39 +16,40 @@ export const supabase = createClient(
 
 const app = express();
 
-// 1) Enable CORS for your domains
+
 app.use(
   cors({
-    origin: config.ALLOWED_ORIGINS || "*", // e.g. 'https://club.example.com'
+    origin: config.ALLOWED_ORIGINS || "*",
     methods: ["GET", "POST", "PATCH", "DELETE", "OPTIONS"],
     credentials: true,
   }),
 );
 
-// 2) Parse JSON and form data
+
 app.use(json());
 app.use(urlencoded({ extended: true }));
 
-// 3) Handle file uploads (in-memory)
+
 const upload = multer({ storage: multer.memoryStorage(),
   limits: { fileSize: 2 * 1024 * 1024 }
 });
 
-// 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("/health",(req,res)=>{
+  res.status(200).json({ message: "OK" });
+})
 
 app.use("/api/v1", routes(upload, supabase));
 
-// 5) 404 handler
+// 404 handler
 app.use((req, res) => {
   res.status(404).json({ message: "Not Found" });
 });
 
-// 6) Global error handler
+
+// Global error handler
 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
+// Serve API documentation
 app.use("/docs", express.static(path.join(__dirname, "..", "docs/apidoc")));
 export default app;

src/routes/achievements.ts

@@ -20,7 +20,7 @@ export function parseCreateAchievementData(req: Request, res: Response, next: Ne
 
 export default function acheivementsRouter(upload: Multer, supabase: SupabaseClient) {
     const router = express.Router();
-
+    
 
     /**
    * @api {get} /achievements Get all achievements

src/routes/index.ts

@@ -17,7 +17,7 @@ export default function routes(upload: Multer, supabase: SupabaseClient) {
 
   router.use('/achievements' ,acheivementsRouter(upload, supabase));
 
-  router.use('/interviews', interviewRouter(upload, supabase));
+  router.use('/interviews', interviewRouter());
 
   router.use('/topics',topicRouter());
 

src/routes/interviews.ts

@@ -1,13 +1,8 @@
 import express from 'express';
 import * as interviewCtrl from '../controllers/interview.controller';
-import { supabase } from '../app';
-import { Multer } from 'multer';
-import { NextFunction } from 'express-serve-static-core';
-import { SupabaseClient } from '@supabase/supabase-js';
 
 
-
-export default function interviewRouter(upload: Multer, supabase: SupabaseClient) {
+export default function interviewRouter() {
     const router = express.Router();
 
     /**
@@ -106,7 +101,7 @@ export default function interviewRouter(upload: Multer, supabase: SupabaseClient
    * @apiParam (Path Params) {Number} id Interview ID to delete
    *
    * @apiSuccess {String} message Deletion confirmation
-   *
+   * @apiBody (Request Body) {UUID} memberId Member ID of the owner
    * @apiError (400) BadRequest Invalid interview ID
    * @apiError (404) NotFound Interview not found
    * @apiError (500) InternalServerError Internal server error

src/utils/apiError.ts

@@ -1,4 +1,3 @@
-// src/utils/apiError.ts
 import { Request, Response, NextFunction } from "express";
 
 /**
@@ -17,9 +16,7 @@ export class ApiError extends Error {
   }
 }
 
-/**
- * Standard structure for API error responses
- */
+
 interface ErrorResponse {
   error: boolean;
   message: string;