documentation updated 2

Author: Codehackerone

controllers/booking.controller.js

@@ -2,6 +2,9 @@ const bookingService = require("../services/booking.service");
 const slotService = require("../services/slot.service");
 const garageService = require("../services/garage.service");
 
+/* ------------ Controllers ----------- */
+
+//renderNewBooking... renders the new booking page
 const renderNewBooking = async (req, res) => {
   var slot_id = req.params.id;
   var slot = await slotService.FindSlot(slot_id);
@@ -24,6 +27,7 @@ const renderNewBooking = async (req, res) => {
   }
 };
 
+//newBooking... creates a new booking calculating the price, and redirects to the dashboard
 const newBooking = async (req, res) => {
   req.body.start_time = new Date(req.body.start_datetime).getTime() / 1000;
   req.body.end_time = new Date(req.body.end_datetime).getTime() / 1000;
@@ -40,6 +44,7 @@ const newBooking = async (req, res) => {
   }
 };
 
+//renderBooking... renders the booking page
 const renderBooking = async (req, res) => {
   var booking_id = req.params.id;
   const booking = await bookingService.FindBooking(booking_id);
@@ -51,6 +56,7 @@ const renderBooking = async (req, res) => {
   }
 };
 
+//deleteBooking... deletes a booking and redirects to the dashboard
 const deleteBooking = async (req, res) => {
   var booking_id = req.params.id;
   try {
@@ -63,6 +69,7 @@ const deleteBooking = async (req, res) => {
   }
 };
 
+//cancelBooking... cancels a booking and redirects to the dashboard
 const cancelBooking = async (req, res) => {
   var id = req.params.id;
   try {

controllers/garage.controller.js

@@ -1,27 +1,36 @@
 const garageService = require("../services/garage.service");
 const slotService = require("../services/slot.service");
-const mbxGeocoding = require("@mapbox/mapbox-sdk/services/geocoding");
+const mbxGeocoding = require("@mapbox/mapbox-sdk/services/geocoding"); // mapbox geocoding api
 const mapBoxToken = process.env.MAPBOX_TOKEN;
 const geocoder = mbxGeocoding({ accessToken: mapBoxToken });
 var axios = require('axios');
 
+/* ------------ Controllers ----------- */
+
+//renderAddGarage... renders the add garage page
 const renderAddGarage = (req, res) => {
   res.render("garages/newgarages", { body: req.body });
 };
 
+//addGarage... adds a new garage to the database
 const addGarage = async (req, res) => {
   try {
+    // checking if request body has an image 
     if (req.file) {
       var path = req.file.path;
       req.body.picture_url = path;
     }
+    // geocding the location
     const geoData = await geocoder
       .forwardGeocode({
         query: req.body.location,
         limit: 1,
       })
       .send();
+    // getting the coordinates
     req.body.geometry = geoData.body.features[0].geometry;
+
+    // adding the garage
     const result = await garageService.AddGarage(req.body);
     req.flash("success", "Garage Added Successfully");
     res.redirect("/garage/");
@@ -46,6 +55,7 @@ const renderGarage = async (req, res) => {
   }
 };
 
+//renderAllGarages... renders all the garages in the database
 const renderAllGarages = async (req, res) => {
   var garages = await garageService.AllGarages();
   res.render("garages/allgarages", {
@@ -55,6 +65,7 @@ const renderAllGarages = async (req, res) => {
   });
 };
 
+//apiSlotInfo... returns the slots info of a garage
 const apiSlotInfo = async (req, res) => {
   var garage_id = req.params.id;
   var garage = await garageService.FindGarage(garage_id);
@@ -77,6 +88,7 @@ const apiSlotInfo = async (req, res) => {
   res.send(str);
 };
 
+//renderEditGarage... renders the edit garage page
 const deleteGarage = async (req, res) => {
   try {
     var id = req.params.id;
@@ -89,11 +101,14 @@ const deleteGarage = async (req, res) => {
   }
 };
 
+//renderFindGarage... renders the find garage page
 const renderfindgarage=async(req,res)=>
 {
   res.render("garages/findgarage",{ body: req.body});
 }
 
+//TODO: IN PROGRESS
+//rendergaragebyIp... renders the garages in progress
 const rendergaragebyip=async(req,res)=>
 {
   if(req.ipv4!==undefined)
@@ -113,6 +128,7 @@ const rendergaragebyip=async(req,res)=>
   res.render("garages/foundgarage",{ body: req.body, by:"IP"})
 }
 
+//rendergaragebyloc... renders the garages in progress
 const rendergaragebyloc=async(req,res)=>
 {
   try{
@@ -123,6 +139,7 @@ const rendergaragebyloc=async(req,res)=>
     }
     else
     {
+      // geocding the location taken from user
       const geoData = await geocoder
           .forwardGeocode({
             query: req.body.location,
@@ -135,6 +152,7 @@ const rendergaragebyloc=async(req,res)=>
       var min_distance=10000000.0;
       var dist={};
       for (let garage of garages){
+        // getting the distance between the garage and the user
         var distance=garageService.DistanceCal(geometry.coordinates[1],geometry.coordinates[0],
           garage.geometry.coordinates[1],garage.geometry.coordinates[0]);
         if(distance<=min_distance)

controllers/slot.controller.js

@@ -2,11 +2,16 @@ const slotService = require("../services/slot.service");
 const garageService = require("../services/garage.service");
 const bookingService = require("../services/booking.service");
 
+/* ------------ Controllers ----------- */
+
+//renderAddSlot... renders add slot page
 const renderAddSlot = (req, res) => {
   var garage_id = req.params.id;
   res.render("slots/addslot", { garage_id: garage_id, body: req.body });
 };
 
+
+//addSlot... adds a new slot to the garage
 const addSlot = async (req, res) => {
   try {
     const result = await slotService.AddSlot(req.body);
@@ -18,6 +23,7 @@ const addSlot = async (req, res) => {
   }
 };
 
+//renderSlot... renders the slot page
 const renderSlot = async (req, res) => {
   var slot_id = req.params.id;
   const slot = await slotService.FindSlot(slot_id);
@@ -41,6 +47,7 @@ const renderSlot = async (req, res) => {
   }
 };
 
+//deleteSlot... deletes a slot from the garage
 const deleteSlot = async (req, res) => {
   var slot_id = req.params.id;
   try {
@@ -52,6 +59,7 @@ const deleteSlot = async (req, res) => {
   }
 };
 
+//renderSlot... renders the slot page
 const renderSlots = async (req, res) => {
   var garage_id = req.params.id;
   var garage = await garageService.FindGarage(garage_id);
@@ -73,6 +81,7 @@ const renderSlots = async (req, res) => {
   }
 };
 
+//findBookings... returns all bookings for a slot
 const findBookings = async (id) => {
   var slot = await slotService.FindSlot(id);
   if (!slot) return "Slot Not Found";
@@ -85,6 +94,7 @@ const findBookings = async (id) => {
   return arr_booking;
 };
 
+//apiBooking... returns all booking details for a slot
 const apiBooking = async (req, res) => {
   var slot_id = req.params.id;
   var arr_booking = await findBookings(slot_id);

controllers/user.controller.js

@@ -4,6 +4,9 @@ const garageService=require("../services/garage.service");
 const slotService=require("../services/slot.service");
 const jwt = require("jsonwebtoken");
 
+/* ------------ Configs ----------- */
+
+// cookie options
 let options = {
   path: "/",
   sameSite: true,
@@ -17,12 +20,21 @@ let options_otp = {
   maxAge: 1000 * 60 * 5,
   httpOnly: true,
 };
+
+/* ------------ Controllers ----------- */
+
+
+//renderRegister... renders the register page
 const renderRegister = (req, res) => {
   res.render("users/register");
 };
+
+//renderLogin... renders the login page
 const renderLogin = (req, res) => {
   res.render("users/login");
 };
+
+//renderDashboard... renders the dashboard page
 const renderDashboard = async (req, res) => {
   var bookings = await bookingService.FindByUser(req.body.user_id);
   for (let booking of bookings) {
@@ -35,9 +47,13 @@ const renderDashboard = async (req, res) => {
   }
   res.render("users/dashboard", { body: req.body, bookings: bookings });
 };
+
+//renderAddMoney... renders the add money page
 const renderAddMoney = (req, res) => {
   res.render("users/addmoney", { money: req.body.money, body: req.body });
 };
+
+//renderVerify... renders the otp verify page
 const renderVerify = async (req, res) => {
   if (req.body.verified === true) {
     res.send("Already Verified");
@@ -47,6 +63,8 @@ const renderVerify = async (req, res) => {
     res.render("users/verify", { email: req.body.email });
   }
 };
+
+//renderRegister... renders the register page
 const register = async (req, res) => {
   try {
     const result = await userService.Register(req.body);
@@ -59,6 +77,7 @@ const register = async (req, res) => {
   }
 };
 
+//sendOtp... sends otp to the user
 const sendOtp = async (username) => {
   try {
     var gen_otp = await userService.generateOtp(username);
@@ -68,6 +87,7 @@ const sendOtp = async (username) => {
   }
 };
 
+// login... logs in the user
 const login = async (req, res) => {
   try {
     const result = await userService.Login(
@@ -83,12 +103,14 @@ const login = async (req, res) => {
   }
 };
 
+// logout... logs out the user
 const logout = (req, res) => {
   res.clearCookie("isloggedin");
   req.flash("success", "Logged out Successfully.");
   res.redirect("/");
 };
 
+//verify.. verifies the otp and logs in the user
 const verify = async (req, res) => {
   var otp = req.body.otp;
   let token = req.cookies["otp"];
@@ -106,10 +128,12 @@ const verify = async (req, res) => {
   }
 };
 
+//renderImageChange... renders the upload image page
 const renderImage = (req, res) => {
   res.render("users/uploadimage", { body: req.body });
 };
 
+//upload Image... uploads the image
 const uploadImage = async (req, res) => {
   var path = req.file["path"];
   var userid = req.body.user_id;
@@ -124,6 +148,7 @@ const uploadImage = async (req, res) => {
   }
 };
 
+//addMoney... adds money to the user
 const addMoney = async (req, res) => {
   var add_money = req.body.added_money;
   try {
@@ -136,6 +161,7 @@ const addMoney = async (req, res) => {
   }
 };
 
+//apiOtp... compares the given otp with the otp stored in cookie
 const apiOtp = (req, res) => {
   var str = req.params.value;
   let token = req.cookies["otp"];
@@ -144,11 +170,13 @@ const apiOtp = (req, res) => {
   else res.send("0");
 };
 
+//resendOtp... resends the otp to the user
 const resendOTP = (req, res) => {
   req.flash("alert", "Your OTP has been resent successfully to your email.");
   res.redirect("/users/verify");
 };
 
+//renderTransactions... renders the transactions page
 const renderTransactions = async (req, res) => {
   var transactions = await userService.getTransactions(req.body.user_id);
   res.render("users/transactions", {
@@ -157,6 +185,7 @@ const renderTransactions = async (req, res) => {
   });
 };
 
+//renderBookings... renders the booking page
 const renderBookings = async (req, res) => {
   var bookings = await bookingService.FindByUser(req.body.user_id);
   for (let booking of bookings) {
@@ -170,6 +199,7 @@ const renderBookings = async (req, res) => {
   res.render("users/bookings", { body: req.body, bookings: bookings });
 };
 
+//renderBooking... renders the booking details page
 const renderBooking=async(req,res)=>
 {
     var id=req.params.id;

models/user.model.js

@@ -48,7 +48,8 @@ const userSchema = new Schema(
   }
 );
 
-userSchema.pre("save", async function (next) {
+// hashes the password before saving using bcrypt
+userSchema.pre("save", async function (next) { 
   if (!this.isModified || !this.isNew) {
     next();
   } else this.isModified("password");

routes/booking.route.js

@@ -1,9 +1,13 @@
+/* ------------ Imports  ----------- */
+
 const express = require("express");
 const Router = express.Router();
 const bookingController = require("../controllers/booking.controller");
 const IsLoggedInMiddleware = require("../middleware/login.middleware");
 const sanitizerMiddleware = require("../middleware/sanitizer.middleware");
 
+/* ------------ Endpoint Definitions ----------- */
+
 Router.route("/new/:id")
   .get(IsLoggedInMiddleware(), bookingController.renderNewBooking)
   .post(IsLoggedInMiddleware(), bookingController.newBooking);

routes/garage.route.js

@@ -1,3 +1,5 @@
+/* ------------ Imports  ----------- */
+
 const express = require("express");
 const Router = express.Router();
 const multer = require("multer");
@@ -9,6 +11,8 @@ const sanitizerMiddleware = require("../middleware/sanitizer.middleware");
 const IsAdminMiddleware = require("../middleware/isadmin.middleware");
 const getIpMiddleware=require("../middleware/ip.middleware");
 
+/* ------------ Endpoint Definitions ----------- */
+
 Router.route("/").get(
   IsLoggedInMiddleware(),
   garageController.renderAllGarages