Merge pull request #1 from SprintCV-S24/jg-config

Config and project structure

Author: jackgarritano

.gitignore

@@ -2,4 +2,5 @@
 dist/
 */node_modules/
 *.env
-config/serviceAccountKey.json
+config/serviceAccountKey.json
+node_modules

package-lock.json

@@ -16,9 +16,10 @@
     "cors": "^2.8.5",
     "dotenv": "^16.1.4",
     "express": "^4.18.2",
+    "firebase-admin": "^11.2.0",
     "helmet": "^7.0.0",
-    "morgan": "^1.10.0",
-    "firebase-admin": "^11.2.0"
+    "mongoose": "^8.1.1",
+    "morgan": "^1.10.0"
   },
   "devDependencies": {
     "@types/cors": "^2.8.13",

package.json

@@ -0,0 +1 @@
+This is just here so the folder is tracked by git

src/controllers/.gitkeep

@@ -3,9 +3,10 @@ import dotenv from "dotenv";
 import cors from "cors";
 import morgan from "morgan";
 import helmet from "helmet";
-import { exampleRoute } from "./routes/exampleRoute";
+import { exampleRoute } from "./routers/exampleRoute";
 import { verifyToken } from "./middlewares/verifyToken";
 import { notFound, errorHandler } from "./middlewares/errors";
+import { connectDb } from "./utils/mongodb";
 
 dotenv.config();
 
@@ -35,5 +36,6 @@ app.use(notFound);
 app.use(errorHandler);
 
 app.listen(PORT, () => {
+  connectDb();
   console.log(`Server is running on port ${PORT}`);
 });

src/index.ts

@@ -0,0 +1,36 @@
+//this is a model from another project with comments added
+
+//get default import from mongoose library (which is used for interacting w/ mongodb)
+import mongoose from "mongoose";
+
+//mongoose object for defining structure of all the documents in a mongodb collection
+const Schema = mongoose.Schema;
+
+//typescript type corresponding with the mongoose schema structure
+export interface eventType {
+  name: string;
+  description: string;
+  code: string;
+  date: Date;
+  programs: string[];
+  staff: string[];
+  attended_youth?: string[];
+  attached_forms?: string[];
+}
+
+//mongoose schema for an event document
+const Event = new Schema<eventType>({
+  name: { type: String, required: true },
+  description: { type: String, required: true },
+  code: { type: String, required: true },
+  date: { type: Date, required: true },
+  programs: { type: [String], required: true },
+  staff: { type: [String], required: true }, // by Staff.fireID
+  attended_youth: { type: [String], default: [] }, // by Youth.fireID
+  attached_forms: { type: [String], default: [] }, // by Note._id
+});
+
+//this takes the schema and uses it to form a model object. Model objects allow us 
+//to interact with mongodb, such as creating new documents or querying documents. The event 
+//model object is exported so that it can be used in other files
+export const EventModel = mongoose.model("Event", Event);