Rewrite iOS course backend

Author: vinnie4k

.envtemplate

@@ -0,0 +1 @@
+MONGO_URI=[insert here]

.github/pull_request_template.md

@@ -0,0 +1,40 @@
+## Overview
+
+<!-- Provide a one-sentence summary about this PR. -->
+
+## Changes Made
+
+<!-- Summarize changes made in this PR. -->
+
+### Change 1
+
+- TODO
+- TODO
+
+### Change 2
+
+- TODO
+- TODO
+
+## Test Coverage
+
+<!-- Provide step-by-step instructions on how to test. -->
+
+## Next Steps (optional)
+
+<!-- Describe the next steps, if applicable. -->
+
+## Related PRs or Issues (optional)
+
+<!-- Link any connect PRs or GitHub Issues, if applicable. -->
+
+## Screenshots
+
+<!-- Replace 'TODO' with a title, then use the provided `<img>` and `<video>` tags as a template. -->
+<!-- If multiple sections are needed, duplicate the `<details>` block. -->
+
+<details>
+  <summary>TODO</summary>
+  <img src="enterurlhere" width="300px" height="auto">
+  <video src="enterurlhere" type="video/mp4">
+</details>

.github/workflows/deploy.yaml

@@ -0,0 +1,46 @@
+name: Production Deployment
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  setup-build-publish-deploy:
+    name: Setup, Build, Publish, and Deploy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Auth Docker
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Get SHA
+        id: vars
+        run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
+
+      - name: Build
+        run: |-
+          docker build --tag "cornellappdev/ios-course-backend:${{ steps.vars.outputs.sha_short }}" .
+
+      - name: Publish
+        run: |-
+          docker push "cornellappdev/ios-course-backend:${{ steps.vars.outputs.sha_short }}"
+
+      - name: SSH & Deploy
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.SERVER_HOST }}
+          username: ${{ secrets.SERVER_USER }}
+          key: ${{ secrets.PRIVATE_KEY }}
+          script: |
+            export IOS_COURSE_IMG_TAG="${{ steps.vars.outputs.sha_short }}"            
+            cd docker-compose
+            yes | docker system prune --all --volumes
+            docker-compose down --remove-orphans
+            docker-compose up -d --build

.github/workflows/jestci.yaml

@@ -0,0 +1,30 @@
+name: Jest CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          cache-dependency-path: ./yarn.lock
+          node-version: ${{ matrix.node-version }}
+          cache: "yarn"
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run Jest tests
+        run: yarn test

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+node_modules/
+package-lock.json
+*.env
+build/

.prettierrc

@@ -0,0 +1,22 @@
+{
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "endOfLine": "lf",
+  "htmlWhitespaceSensitivity": "css",
+  "insertPragma": false,
+  "singleAttributePerLine": false,
+  "bracketSameLine": false,
+  "jsxBracketSameLine": false,
+  "jsxSingleQuote": false,
+  "printWidth": 80,
+  "proseWrap": "preserve",
+  "quoteProps": "as-needed",
+  "requirePragma": false,
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "embeddedLanguageFormatting": "auto",
+  "vueIndentScriptAndStyle": false
+}

Dockerfile

@@ -0,0 +1,12 @@
+FROM node:20
+
+RUN mkdir /usr/app
+WORKDIR /usr/app
+
+COPY yarn.lock .
+COPY package.json .
+
+RUN yarn install
+COPY . .
+EXPOSE 8000
+CMD ["yarn", "start"]

README.md

@@ -1,2 +1,30 @@
 # ios-course-backend
+
 Backend for L7: Networking II and A3
+
+## About This Backend
+
+The database is hosted on MongoDB Atlas. There are two collections:
+
+1. posts (A3: ChatDev)
+2. members (L7: Networking II)
+
+A CI/CD script has been created - simply merge a PR to `main` to deploy, after all checks have passed. If needed, the SSH key is pinned in our Slack.
+
+## Getting Started
+
+1. Duplicate the `.envtemplate` file and rename it to `.env`. Set `MONGO_URI` to the database URI.
+2. Run `yarn` to install dependencies. If you don't have yarn installed, run `npm install --global yarn`.
+3. Start the development server by running `yarn dev`. To run the production build instead, use `yarn build` followed by `yarn start`.
+4. API documentation can be found in the `/api/docs` route.
+
+## Testing
+
+### Jest
+
+1. Make sure dependencies are installed with `yarn`.
+2. To run the test suite, use `yarn test`.
+
+## Styling
+
+- If using VSCode, install the Prettier extension and configure your settings to use it.

jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  transformIgnorePatterns: ["<rootDir>/node_modules/"],
+  moduleFileExtensions: ["js", "ts"],
+  maxWorkers: 1,
+};

nodemon.json

@@ -0,0 +1,5 @@
+{
+  "events": {
+    "restart": "tsoa spec-and-routes"
+  }
+}

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "ios-course-backend",
+  "version": "1.0.0",
+  "main": "src/index.ts",
+  "scripts": {
+    "start": "tsoa spec-and-routes && ts-node -r dotenv/config src/index.ts",
+    "dev": "tsoa spec-and-routes && nodemon -r dotenv/config src/index.ts --watch src --config nodemon.json",
+    "build": "tsoa spec-and-routes && tsc --outDir build --experimentalDecorators",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@typegoose/typegoose": "^12.4.0",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.12.12",
+    "@types/swagger-ui-express": "^4.1.6",
+    "body-parser": "^1.20.2",
+    "dotenv": "^16.4.5",
+    "express": "^4.19.2",
+    "mongodb-memory-server": "^10.0.0",
+    "mongoose": "^8.3.5",
+    "node-fetch-commonjs": "^3.3.2",
+    "nodemon": "^3.1.0",
+    "swagger-ui-express": "^5.0.0",
+    "ts-node": "^10.9.2",
+    "tsoa": "^6.2.1",
+    "typescript": "^5.4.5"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^8.4.1",
+    "@jest/globals": "^29.7.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5"
+  }
+}

src/database.ts

@@ -0,0 +1,23 @@
+import mongoose from "mongoose";
+
+/**
+ * Connects to the MongoDB database.
+ *
+ * Retrieves the MongoDB URI from the `MONGO_URI` environment variable
+ * and establishes a connection to the database.
+ */
+export const dbConnect = async () => {
+  const uri = process.env.MONGO_URI;
+
+  // Connect to MongoDB
+  await mongoose.connect(uri!);
+  console.log("✅ Connected to MongoDB");
+};
+
+/**
+ * Disconnects from the MongoDB database.
+ */
+export const dbDisconnect = async () => {
+  await mongoose.disconnect();
+  console.log("✅ Disconnected from MongoDB");
+};

src/index.html

@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Intro to iOS Development Backend</title>
+    <style>
+      body {
+        font-family: sans-serif;
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        justify-content: center;
+        min-height: 100vh;
+        background-color: #f0f0f0;
+        margin: 0;
+      }
+
+      h1 {
+        color: #333;
+      }
+
+      p {
+        text-align: center;
+        margin-bottom: 20px;
+      }
+
+      a {
+        display: inline-block;
+        padding: 10px 20px;
+        background-color: #007bff;
+        color: #fff;
+        text-decoration: none;
+        border-radius: 5px;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>Welcome to the backend for Intro to iOS Development!</h1>
+    <p>If you have any questions, reach out to Vin on Slack.</p>
+    <a href="/api/docs">Click here to view API docs</a>
+  </body>
+</html>

src/index.ts

@@ -0,0 +1,50 @@
+import express, { Request, Response } from "express";
+import bodyParser from "body-parser";
+import swaggerUI from "swagger-ui-express";
+import { RegisterRoutes } from "../build/routes";
+import { dbConnect } from "./database";
+import { errorMiddleware } from "./middleware/errorMiddleware";
+
+/**
+ * Initializes and starts the Express server.
+ *
+ * This script sets up the Express server with the following configurations:
+ * - Body parsing: Uses `body-parser` to parse JSON request bodies.
+ * - Default route: Serves an `index.html` file from the current directory for the root path.
+ * - Swagger documentation: Sets up Swagger UI for API documentation at `/api/docs`.
+ * - API routes: Registers API routes from the generated `routes` file.
+ * - Error handling: Uses a custom error middleware to handle errors.
+ * - Database connection: Connects to the MongoDB database using the `dbConnect` function.
+ *
+ * The server listens on the port specified by the `PORT` environment variable or port 8000 if not defined.
+ */
+
+// Express Server
+const app = express();
+app.use(bodyParser.json());
+
+// Default Route
+app.get("/", (req, res) => {
+  return res.sendFile("index.html", { root: __dirname });
+});
+
+// Swagger API Docs
+app.use("/api/docs", swaggerUI.serve, async (req: Request, res: Response) => {
+  return res.send(
+    swaggerUI.generateHTML(await import("../build/swagger.json"))
+  );
+});
+
+RegisterRoutes(app);
+
+// Define error middleware last
+app.use(errorMiddleware);
+
+app.listen(process.env.PORT || 8000, async () => {
+  console.log(
+    `✅ Server is up and running at http://localhost:${
+      process.env.PORT || 8000
+    }`
+  );
+  await dbConnect();
+});

src/members/examples.ts

@@ -0,0 +1,22 @@
+/**
+ * An example member object.
+ */
+export const exampleMember = {
+  /**
+   * The name of the member.
+   */
+  name: "Vin Bui",
+  /**
+   * The position or role of the member.
+   */
+  position: "Course Instructor",
+  /**
+   * The subteam the member belongs to.
+   */
+  subteam: "iOS",
+};
+
+/**
+ * An array containing the example member.
+ */
+export const exampleMembers = [exampleMember];