Merge branch 'development' into 260-create-apidoc-for-practical

Author: TejasNair9977

.eslintrc.cjs

@@ -4,7 +4,7 @@ module.exports = {
     es2021: true,
     jest: true
   },
-  extends: "airbnb-base",
+  extends: ["airbnb-base", "prettier"],
   overrides: [],
   parserOptions: {
     ecmaVersion: "latest",

.prettierignore

@@ -0,0 +1,7 @@
+**/node_modules
+**/apidoc
+**/.git
+**/_apidoc.js
+**/*.json
+**/*.css
+Dockerfile

.prettierrc

@@ -1,4 +1,5 @@
 {
-    "singleQuote": true,
-    "tabWidth": 2
+    "singleQuote": false,
+    "tabWidth": 2,
+    "semi": true
 }

Contribution.md renamed to CONTRIBUTING.md

@@ -764,3 +764,285 @@
  *
  * @apiError (Error 400) {String} err Error message for bad requests.
  */
+
+// ------------------------------------------------------------------------------------------
+// Group.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {post} /group/add Add Group
+ * @apiName AddGroup
+ * @apiGroup Group
+ * @apiDescription Add a new group.
+ *
+ * @apiBody {String} title Group title.
+ * @apiBody {ObjectId[]} students Array of student ObjectIDs.
+ *
+ * @apiSuccess {String} res Response message.
+ * @apiError (Error 500) GroupAddError Error while adding the group
+ *
+ * @apiSuccessExample Success-Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "added group Example Group"
+ *     }
+ *
+ * @apiErrorExample Error-Response:
+ *     HTTP/1.1 500 Internal Server Error
+ *     {
+ *       "err": "Error while inserting in DB"
+ *     }
+ */
+
+// ------------------------------------------------------------------------------------------
+// Semester
+// ------------------------------------------------------------------------------------------
+/**
+ * @api {post} /semester/add Request to add Semester information
+ * @apiName Addsemester
+ * @apiGroup Semester
+ *
+ * @apiQuery {Number} [number] Number of semester
+ * @apiQuery {String} [academicYear] To show the current academic year
+ * @apiQuery {String} [type] Stores the enum ODD or EVEN for semester
+ * @apiQuery {Date} [startDate] Start date of the semester
+ * @apiQuery {Date} [endDate] End date of the semester
+ *
+ * @apiSuccess {String} res Response message .
+ * @apiError (Error 500) DatabaseError Err message if there is an error inserting into the database.
+ *
+ */
+
+/**
+ * @api {get} /semester/list Request to list Semester information
+ * @apiName semesterlist
+ * @apiGroup Semester
+ *
+ * @apiQuery {Number} [number] Number of semester
+ * @apiQuery {String} [academicYear] To show the current academic year
+ * @apiQuery {String} [type] Stores the enum ODD or EVEN for semester
+ * @apiQuery {Date} [startDate] Start date of the semester
+ * @apiQuery {Date} [endDate] End date of the semester
+ *
+ * @apiSuccess {semester[]} res Array of Filtered semester Doc.
+ * @apiSuccess {Number} semester.number Number of semester
+ * @apiSuccess {String} semester.academicYear To show the current academic year of the semester
+ * @apiSuccess {String} semester.type Stores the enum ODD or EVEN for semester
+ * @apiSuccess {Date} semester.startDate Start date of the semester
+ * @apiSuccess {Date} semester.endDate End date of the semester
+ *
+ */
+
+/**
+ * @api {update} /semester/update/:id Request to list Semester information
+ * @apiName Updatesemester
+ * @apiGroup Semester
+ *
+ * @apiBody {Number} [number] Number of semester
+ * @apiBody {String} [academicYear] To show the current academic year
+ * @apiBody {String} [type] Stores the enum ODD or EVEN for semester
+ * @apiBody {Date} [startDate] Start date of the semester
+ * @apiBody {Date} [endDate] End date of the semester
+ *
+ *@apiSuccess {String} res Semester updated.
+ * @apiError (Error 500) DatabaseError Error in updating the database.
+ *
+ */
+
+/**
+* @api {delete} /semester/delete/:id Request to list Semester information
+* @apiName Deletesemester
+* @apiGroup Semester
+*
+* @apiParam {String} id The ID of the Semester document to delete.
+*
+* @apiSuccess {String} res Success message indicating the deletion.
+*
+* @apiError (Error 500) DatabaseError Error message if there was an error during the deletion.
+*/
+
+
+// ------------------------------------------------------------------------------------------
+// Activity.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {post} /activity/add Add Activty.
+ * @apiName AddActivity
+ * @apiGroup Activity
+ *
+ * @apiBody {Date} startTime The startTime of the activity.
+ * @apiBody {Number} duration The duration of the activity (in minutes).
+ * @apiBody {ObjectId} course The course of the activity (ObjectId).
+ * @apiBody {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiBody {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiBody {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiBody {ObjectId} group The group of the activity (ObjectId).
+ * @apiBody {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {String} res Response message.
+ *
+ * @apiError (Error 500) DatabaseError Error while inserting in the database.
+ *
+ * @apiDescription Adds a new Activity to the system.
+ *
+ * @apiSuccessExample Success-Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "Added activity"
+ *     }
+ *
+ * @apiErrorExample Error-Response:
+ *     HTTP/1.1 500 Internal Server Error
+ *     {
+ *       "err": "Error while inserting in DB"
+ *     }
+ */
+
+/**
+ * @api {delete} /group/delete/:id Delete Group
+ * @apiName DeleteGroup
+ * @apiGroup Group
+ *
+ * @apiParam {ObjectId} id The ObjectID of the group to delete.
+ *
+ * @apiSuccess {String} res Success message indicating the deletion.
+ * @apiError (Error 500) GroupDeleteError Error while deleting the group
+ *
+ */
+
+/**
+ * @api {post} /group/update/:id Update Group Details
+ * @apiName UpdateGroup
+ * @apiGroup Group
+ * @apiDescription Update existing group details.
+ *
+ * @apiParam {ObjectId} id The ObjectID of the group to update.
+ * @apiBody {String} [title] Group title.
+ * @apiBody {ObjectId[]} [students] Array of student ObjectIDs.
+ *
+ * @apiSuccess {String} res Group updated.
+ * @apiError (Error 500) GroupUpdateError Error in updating database
+ *
+ */
+
+/**
+ * @api {get} /group/list Get Group List
+ * @apiName GetGroupList
+ * @apiGroup Group
+ *
+ * @apiQuery {String} [title] Title of the group.
+ *
+ * @apiSuccess {Group[]} res Array of filtered group documents.
+ * @apiSuccess {ObjectId} group._id ObjectID of the group document in the database.
+ * @apiSuccess {String} group.title Title of the group.
+ * @apiSuccess {ObjectId[]} group.students Array of student ObjectIDs in the group.
+ */
+/**
+ * @api {delete} /timetable/delete/:timetableId Delete Timetable
+ * @apiName DeleteTimetable
+ * @apiGroup Timetable
+ *
+ * @apiParam {String} timetableId The ID of the timetable document to delete.
+ *
+ * @apiSuccess {String} res Success message indicating the deletion.
+ *
+ * @apiError (Error 500) DatabaseError Error message if there was an error during the deletion.
+ */
+
+/**
+ * @api {delete} /activity/delete/:activity Delete Activity.
+ * @apiName DeleteActivity
+ * @apiGroup Activity
+ *
+ * @apiParam {String} Activity The activity document to delete.
+ *
+ * @apiSuccess {String} res Success message indicating the deletion.
+ *
+ * @apiError (Error 500) DatabaseError Error message if there was an error during the deletion.
+ */
+
+/**
+ * @api {post} /timetable/update Update Timetable
+ * @apiName UpdateTimetable
+ * @apiGroup Timetable
+ * @apiDescription Update existing timetable data.
+ *
+ * @apiBody {Date} startTime The startTime of the activity.
+ * @apiBody {Number} duration The duration of the activity (in minutes).
+ * @apiBody {ObjectId} course The course of the activity (ObjectId).
+ * @apiBody {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiBody {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiBody {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiBody {ObjectId} group The group of the activity (ObjectId).
+ * @apiBody {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {String} res Timetable updated.
+ */
+
+/**
+ * @api {post} /activity/update Update Activity.
+ * @apiName UpdateActivity
+ * @apiGroup Activity
+ * @apiDescription Update existing activity data.
+ *
+ * @apiBody {Date} startTime The startTime of the activity.
+ * @apiBody {Number} duration The duration of the activity (in minutes).
+ * @apiBody {ObjectId} course The course of the activity (ObjectId).
+ * @apiBody {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiBody {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiBody {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiBody {ObjectId} group The group of the activity (ObjectId).
+ * @apiBody {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {String} res Activity updated.
+ * @apiError (Error 500) DatabaseError Error in updating the database.
+ */
+
+/**
+ * @api {get} /timetable/list Get Timetable List
+ * @apiName GetTimetableList
+ * @apiGroup Timetable
+ *
+ * @apiQuery {Date} startTime The startTime of the activity.
+ * @apiQuery {Number} duration The duration of the activity (in minutes).
+ * @apiQUERY {ObjectId} course The course of the activity (ObjectId).
+ * @apiQuery {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiQuery {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiQuery {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiQuery {ObjectId} group The group of the activity (ObjectId).
+ * @apiQuery {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {Date} startTime The startTime of the activity.
+ * @apiSuccess {Number} duration The duration of the activity (in minutes).
+ * @apiSuccess {ObjectId} course The course of the activity (ObjectId).
+ * @apiSuccess {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiSuccess {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiSuccess {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiSuccess {ObjectId} group The group of the activity (ObjectId).
+ * @apiSucess {ObjectId} students the students who gonna attend the activity(ObjectId).
+ */
+
+/**
+ * @api {get} /activity/list Get Activity List
+ * @apiName GetActivityList
+ * @apiGroup Activity
+ *
+ * @apiQuery {Date} startTime The startTime of the activity.
+ * @apiQuery {Number} duration The duration of the activity (in minutes).
+ * @apiQUERY {ObjectId} course The course of the activity (ObjectId).
+ * @apiQuery {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiQuery {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiQuery {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiQuery {ObjectId} group The group of the activity (ObjectId).
+ * @apiQuery {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {Date} startTime The startTime of the activity.
+ * @apiSuccess {Number} duration The duration of the activity (in minutes).
+ * @apiSuccess {ObjectId} course The course of the activity (ObjectId).
+ * @apiSuccess {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiSuccess {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiSuccess {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiSuccess {ObjectId} group The group of the activity (ObjectId).
+ * @apiSucess {ObjectId} students the students who gonna attend the activity(ObjectId).
+ */

_apidoc.js

@@ -8,6 +8,7 @@ import { logger } from "#util";
 import indexRouter from "#routes/index";
 import usersRouter from "#routes/users";
 import authRouter from "#routes/auth";
+import semesterRouter from "#routes/semester";
 import accreditationRouter from "#routes/accreditation";
 import infrastructureRouter from "#routes/infrastructure";
 import practicalRouter from "#routes/practical";
@@ -17,9 +18,12 @@ import tutorialRouter from "#routes/tutorial";
 import assignmentRouter from "#routes/assignment";
 import timetableRouter from "#routes/timetable";
 import courseworkRouter from "#routes/coursework";
+import activityRouter from "#routes/activity";
 import moduleRouter from "#routes/module";
+import facultyRouter from "#routes/faculty";
 import { identifyUser } from "#middleware/identifyUser";
 import departmentRouter from "#routes/department";
+import groupRouter from "#routes/group";
 
 const app = express();
 const currDirName = dirname(fileURLToPath(import.meta.url));
@@ -46,10 +50,14 @@ app.use("/department", departmentRouter);
 app.use("/practical", practicalRouter);
 app.use("/organization", organizationRouter);
 app.use("/student", studentRouter);
+app.use("/activity", activityRouter);
 app.use("/tutorial", tutorialRouter);
 app.use("/assignment", assignmentRouter);
 app.use("/timetable", timetableRouter);
 app.use("/department", departmentRouter);
 app.use("/coursework", courseworkRouter);
 app.use("/module", moduleRouter);
+app.use("/group", groupRouter);
+app.use("/semester", semesterRouter);
+app.use("/faculty", facultyRouter);
 export default app;