add comments

swapnil-ahlawat · Mar 29, 2021 · 121ab4e · 121ab4e
1 parent 5d0adf4
commit 121ab4e
Show file tree

Hide file tree

Showing 23 changed files with 90 additions and 46 deletions.
diff --git a/Backend/app.js b/Backend/app.js
@@ -6,6 +6,8 @@ const userRouter = require('./routes/user-routes');
 const packageRouter = require('./routes/package-routes');
 
 const app = express();
+//This is the initial database that has been added to the User database.
+//This is required as there is no SignUp functionality in out app right now.
 /*
 const DUMMY_USERS = [
   {

diff --git a/Backend/controllers/login-controllers.js b/Backend/controllers/login-controllers.js
@@ -1,6 +1,7 @@
 const mongoose = require('mongoose');
 const User = require('../database/User');
 
+//controller for signing in the app
 const login = async (req, res, next) => {
   const { phoneNo, password, userType } = req.body;
   const identifiedUser = await User.find({ phoneNo, password, userType })

diff --git a/Backend/controllers/package-controllers.js b/Backend/controllers/package-controllers.js
@@ -2,6 +2,7 @@ const mongoose = require('mongoose');
 const Package = require('../database/Package');
 const User = require('../database/User');
 
+//controller for scaning and changing userPhoneNo, packageTag or count of Package
 const scanPackage = async (req, res, next) => {
   const { serialNumber, phoneNo, packageTag } = req.body;
 
@@ -31,6 +32,7 @@ const scanPackage = async (req, res, next) => {
   });
 };
 
+//controller to add package to database
 const addPackage = async (req, res, next) => {
   const { lotNumber, numPackages } = req.body;
   for (i = 0; i < parseInt(numPackages); i++) {
@@ -46,6 +48,7 @@ const addPackage = async (req, res, next) => {
   });
 };
 
+//controller to assign numPackages packages at warehouse to some restaurant
 const sendPackage = async (req, res, next) => {
   const { phoneNo, numPackages } = req.body;
   let identifiedRestaurant = await User.findOne({

diff --git a/Backend/controllers/user-controllers.js b/Backend/controllers/user-controllers.js
@@ -1,7 +1,12 @@
 const mongoose = require('mongoose');
 const User = require('../database/User');
 const Order = require('../database/Order');
-
+/*
+controller to place order:-
+1. creates a new order
+2. adds orderID to restaurant's pending orders array
+3. adds orderID to delivery personnel's pending orders array
+*/
 const placeOrder = async (req, res, next) => {
   const {
     reusablePackageFlag,
@@ -71,6 +76,7 @@ const placeOrder = async (req, res, next) => {
   });
 };
 
+//controller to get pending orders of restaurant/delivery personnel
 const getOrders = async (req, res, next) => {
   const phoneNo = req.query.phoneNo;
   const userType = req.query.userType;
@@ -105,6 +111,7 @@ const getOrders = async (req, res, next) => {
   });
 };
 
+//controller to remove order from restaurant/delivery personnel's order array
 const removeOrder = async (req, res, next) => {
   const { orderID, phoneNo } = req.body;
 
@@ -124,6 +131,7 @@ const removeOrder = async (req, res, next) => {
   });
 };
 
+//controller to add money to user wallet
 const addWalletMoney = async (req, res, next) => {
   const { phoneNo, amount } = req.body;
 
@@ -147,6 +155,7 @@ const addWalletMoney = async (req, res, next) => {
   });
 };
 
+//controller to add discound voucher to use promo codes
 const givePromoReward = async (req, res, next) => {
   const { phoneNo } = req.body;
 

diff --git a/Backend/database/Order.js b/Backend/database/Order.js
@@ -1,6 +1,7 @@
 const mongoose = require('mongoose');
 var Float = require('mongoose-float').loadType(mongoose, 2);
 
+//schema for orders
 const order = new mongoose.Schema({
   customerName: {
     type: String,

diff --git a/Backend/database/Package.js b/Backend/database/Package.js
@@ -1,5 +1,11 @@
 const mongoose = require('mongoose');
-
+/*
+Schema for package
+  serialNumber: unique ID of package,
+  userPhoneNo: phone Number of user who has this package currently
+  packageTag: tag to see progress of package in distribution cycle
+  count: how many times the package has been used till now
+*/
 const package = new mongoose.Schema({
   serialNumber: {
     type: String,

diff --git a/Backend/database/User.js b/Backend/database/User.js
@@ -1,6 +1,7 @@
 const mongoose = require('mongoose');
 var Float = require('mongoose-float').loadType(mongoose, 2);
 
+//schema for users
 const user = new mongoose.Schema({
   name: {
     type: String,

diff --git a/Frontend/navigation/customerTabs.js b/Frontend/navigation/customerTabs.js
@@ -13,6 +13,7 @@ import { COLORS, icons } from '../constants';
 
 const Tab = createBottomTabNavigator();
 
+//Button for Styling
 const TabBarCustomButton = ({ accessibilityState, children, onPress }) => {
   var isSelected = accessibilityState.selected;
 
@@ -63,6 +64,7 @@ const TabBarCustomButton = ({ accessibilityState, children, onPress }) => {
   }
 };
 
+//Bar for Styling
 const CustomTabBar = (props) => {
   if (isIphoneX()) {
     return (
@@ -85,6 +87,7 @@ const CustomTabBar = (props) => {
   }
 };
 
+// tab navigation area
 const CustomerTabs = () => {
   return (
     <Tab.Navigator

diff --git a/Frontend/navigation/personnelTabs.js b/Frontend/navigation/personnelTabs.js
@@ -13,6 +13,7 @@ import { COLORS, icons } from '../constants';
 
 const Tab = createBottomTabNavigator();
 
+//Button for styling
 const TabBarCustomButton = ({ accessibilityState, children, onPress }) => {
   var isSelected = accessibilityState.selected;
 
@@ -63,6 +64,7 @@ const TabBarCustomButton = ({ accessibilityState, children, onPress }) => {
   }
 };
 
+//Bar Styling
 const CustomTabBar = (props) => {
   if (isIphoneX()) {
     return (
@@ -85,6 +87,7 @@ const CustomTabBar = (props) => {
   }
 };
 
+// tab navigation area
 const PersonnelTabs = () => {
   return (
     <Tab.Navigator

diff --git a/Frontend/navigation/restaurantTabs.js b/Frontend/navigation/restaurantTabs.js
@@ -13,6 +13,7 @@ import { COLORS, icons } from '../constants';
 
 const Tab = createBottomTabNavigator();
 
+// button for styling
 const TabBarCustomButton = ({ accessibilityState, children, onPress }) => {
   var isSelected = accessibilityState.selected;
 
@@ -63,6 +64,7 @@ const TabBarCustomButton = ({ accessibilityState, children, onPress }) => {
   }
 };
 
+// bar for styling
 const CustomTabBar = (props) => {
   if (isIphoneX()) {
     return (
@@ -85,6 +87,7 @@ const CustomTabBar = (props) => {
   }
 };
 
+// tab navigation area
 const RestaurantTabs = () => {
   return (
     <Tab.Navigator

diff --git a/Frontend/navigation/warehouseTabs.js b/Frontend/navigation/warehouseTabs.js
@@ -13,6 +13,7 @@ import { COLORS, icons } from '../constants';
 
 const Tab = createBottomTabNavigator();
 
+// button for styling
 const TabBarCustomButton = ({ accessibilityState, children, onPress }) => {
   var isSelected = accessibilityState.selected;
 
@@ -63,6 +64,7 @@ const TabBarCustomButton = ({ accessibilityState, children, onPress }) => {
   }
 };
 
+// bar for styling
 const CustomTabBar = (props) => {
   if (isIphoneX()) {
     return (
@@ -85,6 +87,7 @@ const CustomTabBar = (props) => {
   }
 };
 
+// tab navigation area
 const WarehouseTabs = () => {
   return (
     <Tab.Navigator

diff --git a/Frontend/screens/Cart.js b/Frontend/screens/Cart.js
@@ -16,6 +16,7 @@ import {
 
 import { icons, COLORS, SIZES, FONTS, LINK } from '../constants';
 
+// Order Summary Screen
 const Order = ({ route, navigation }) => {
   const [restaurant, setRestaurant] = useState(null);
   const [orderItems, setOrderItems] = useState([]);
@@ -32,7 +33,8 @@ const Order = ({ route, navigation }) => {
     }
   });
 
-  const placeOrderHandler = async () => {
+  //handler to send place order request to server
+  async function placeOrderHandler() {
     try {
       const response = await fetch(LINK + '/user/placeOrder', {
         method: 'POST',
@@ -66,7 +68,9 @@ const Order = ({ route, navigation }) => {
     } catch (err) {
       alert('Error in placing order. Please try again later.');
     }
-  };
+  }
+
+  //renders header
   function renderHeader() {
     return (
       <View style={{ flexDirection: 'row' }}>
@@ -112,6 +116,7 @@ const Order = ({ route, navigation }) => {
     );
   }
 
+  //renders Restaurant and Customer Details
   function renderInfo() {
     return (
       <View style={{ margin: SIZES.padding * 2, marginBottom: SIZES.padding }}>
@@ -151,6 +156,8 @@ const Order = ({ route, navigation }) => {
       </View>
     );
   }
+
+  //renders Order items
   function renderOrderInfo() {
     const renderItem = ({ item }) => (
       <View
@@ -225,6 +232,8 @@ const Order = ({ route, navigation }) => {
     let total = sumOrder();
     return (0.18 * total).toFixed(2);
   }
+
+  //adds reusable package line on screen if selected
   function reusablePackageFee() {
     if (reusablePackage) {
       return (
@@ -263,6 +272,8 @@ const Order = ({ route, navigation }) => {
       parseFloat(reusablePackage ? 4.0 : 0.0);
     return total.toFixed(2);
   }
+
+  //renders final amounts like tax, subtotal, total, reusable package fee
   function renderTotal() {
     return (
       <View style={{ marginHorizontal: SIZES.padding * 2 }}>
@@ -359,6 +370,7 @@ const Order = ({ route, navigation }) => {
     );
   }
 
+  //render buttons for payment mode
   function renderPaymentMode() {
     return (
       <View
@@ -432,6 +444,8 @@ const Order = ({ route, navigation }) => {
       </View>
     );
   }
+
+  //renders place order button
   function renderPlaceOrderButton() {
     return (
       <TouchableOpacity
@@ -458,6 +472,7 @@ const Order = ({ route, navigation }) => {
     );
   }
 
+  //modal for order confirmation
   function renderPlaceOrderModal() {
     return (
       <Modal animationType="slide" transparent={true} visible={modalVisible}>

diff --git a/Frontend/screens/CustomerHome.js b/Frontend/screens/CustomerHome.js
@@ -13,6 +13,7 @@ import {
 
 import { icons, images, SIZES, COLORS, FONTS } from '../constants';
 
+//First screen where customer comes on signing in
 const CustomerHome = ({ navigation }) => {
   const categoryData = [
     {
@@ -252,27 +253,6 @@ const CustomerHome = ({ navigation }) => {
             </Text>
           </View>
         </View>
-
-        {/* <TouchableOpacity
-                    style={{
-                        width: 50,
-                        paddingRight: SIZES.padding * 2,
-                        justifyContent: 'center'
-                    }}
-                   
-                    onPress={() => navigation.navigate("Cart", {
-                        orderItems: global.orderItems
-                    })}
-                >
-                    <Image
-                        source={icons.basket}
-                        resizeMode="contain"
-                        style={{
-                            width: 30,
-                            height: 30
-                        }}
-                    />
-                </TouchableOpacity> */}
       </SafeAreaView>
     );
   }

diff --git a/Frontend/screens/DeliverOrder.js b/Frontend/screens/DeliverOrder.js
@@ -31,6 +31,7 @@ const DeliverOrder = ({ route, navigation }) => {
     setOrder(item);
   });
 
+  //function to delete order from personnel's pending order array
   async function deleteOrder() {
     var url = LINK + '/user/removeOrder';
     try {
@@ -231,6 +232,7 @@ const DeliverOrder = ({ route, navigation }) => {
       </View>
     );
   }
+
   function renderButton() {
     return (
       <View>
@@ -253,6 +255,7 @@ const DeliverOrder = ({ route, navigation }) => {
       </View>
     );
   }
+
   function renderModeModal() {
     return (
       <Modal animationType="slide" transparent={true} visible={modalVisible}>

diff --git a/Frontend/screens/Order.js b/Frontend/screens/Order.js
@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState, useEffect } from 'react';
 import {
   StyleSheet,
   FlatList,
@@ -16,17 +16,20 @@ import {
 
 import { icons, COLORS, SIZES, FONTS, LINK } from '../constants';
 
+// Screen on which complete selected pending order is displayed
 const Order = ({ route, navigation }) => {
-  const [order, setOrder] = React.useState(null);
-  const [isSelected, setSelection] = React.useState(false);
-  const [modalVisible, setModalVisible] = React.useState(false);
+  const [order, setOrder] = useState(null);
+  const [isSelected, setSelection] = useState(false);
+  const [modalVisible, setModalVisible] = useState(false);
 
-  React.useEffect(() => {
+  useEffect(() => {
     let { item } = route.params;
 
     setOrder(item);
     setSelection(order?.reusablePackageFlag);
   });
+
+  //request to delete order from restaurant's pending orders list
   async function deleteOrder() {
     var url = LINK + '/user/removeOrder';
     try {
@@ -228,7 +231,6 @@ const Order = ({ route, navigation }) => {
             style={{
               height: 25,
               width: 25,
-              // tintColor: COLORS.primary
             }}
           />
         </View>