Merge pull request #35 from CS3219-AY2425S1/development

Question service implementation

Author: ruiqi7

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - "*"
+
+env:
+  NODE_VERSION: 20
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        service: [frontend, backend/question-service, backend/user-service]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setting node version
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Install dependencies
+        working-directory: ${{ matrix.service }}
+        run: npm install
+      - name: Linting
+        working-directory: ${{ matrix.service }}
+        run: npm run lint
+      # - name: Tests
+      #   working-directory: ${{ matrix.service }}
+      #   run: npm test

.github/workflows/lint.yml

@@ -12,8 +12,12 @@ dist
 dist-ssr
 *.local
 
+# Coverage
+coverage
+
 # Editor directories and files
 .vscode/*
+!.vscode/settings.json
 !.vscode/extensions.json
 .idea
 .DS_Store

.gitignore

@@ -0,0 +1,7 @@
+{
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "prettier.tabWidth": 2
+  }
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+MONGO_URI=MONGO_URI
+
+FIREBASE_PROJECT_ID=FIREBASE_PROJECT_ID
+FIREBASE_PRIVATE_KEY=FIREBASE_PRIVATE_KEY
+FIREBASE_CLIENT_EMAIL=FIREBASE_CLIENT_EMAIL
+FIREBASE_STORAGE_BUCKET=FIREBASE_STORAGE_BUCKET
+
+ORIGINS=http://localhost:5173,http://127.0.0.1:5173
+
+USER_SERVICE_URL=USER_SERVICE_URL

backend/question-service/.env.sample

@@ -1 +1,71 @@
 # Question Service
+
+## Setting-up MongoDB
+
+> :notebook: If you are familiar to MongoDB and wish to use a local instance, please feel free to do so. This guide utilizes MongoDB Cloud Services.
+
+1. Set up a MongoDB Shared Cluster by following the steps in this [Guide](../user-service/MongoDBSetup.md).
+
+2. After setting up, go to the Database Deployment Page. You would see a list of the Databases you have set up. Select `Connect` on the cluster you just created earlier.
+
+   ![alt text](../user-service/GuideAssets/ConnectCluster.png)
+
+3. Select the `Drivers` option, as we have to link to a Node.js App (Question Service).
+
+   ![alt text](../user-service/GuideAssets/DriverSelection.png)
+
+4. Select `Node.js` in the `Driver` pull-down menu, and copy the connection string.
+
+   Notice, you may see `<password>` in this connection string. We will be replacing this with the admin account password that we created earlier on when setting up the Shared Cluster.
+
+   ![alt text](../user-service/GuideAssets/ConnectionString.png)
+
+5. In the `question-service` directory, create a copy of the `.env.sample` file and name it `.env`.
+
+6. Update the `MONGO_URI` of the `.env` file, and paste the string we copied earlier in step 4.
+
+## Setting-up Firebase
+
+1. Go to https://console.firebase.google.com/u/0/.
+
+2. Create a project and choose a project name. Navigate to `Storage` and click on it to activate it.
+
+3. Select `Start in production mode` and your preferred cloud storage region.
+
+4. After Storage is created, go to `Rules` section and set rule to:
+
+   ```
+   rules_version = '2';
+   service firebase.storage {
+     match /b/{bucket}/o {
+       match /{allPaths=**} {
+         allow read: if true;
+         allow write: if request.auth != null;
+       }
+     }
+   }
+   ```
+
+   This rule ensures that only verified users can upload images while ensuring that URLs of images are public. Remember to click `Publish` to save changes.
+
+5. Go to `Settings`, `Project settings`, `Service accounts` and click `Generate new private key`. This will download a `.json` file, which will contain your credentials.
+
+6. In `.env` of question service, replace:
+   - `FIREBASE_PROJECT_ID` with `project_id` found in the downloaded json file.
+   - `FIREBASE_PRIVATE_KEY` with `private_key` found in the downloaded json file.
+   - `FIREBASE_CLIENT_EMAIL` with `client_email` found in the downloaded json file.
+   - `FIREBASE_STORAGE_BUCKET` with the folder path of the Storage. It should look something like `gs://<appname>.appspot.com`.
+
+## Running Question Service
+
+1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
+
+2. Open Command Line/Terminal and navigate into the `question-service` directory.
+
+3. Run the command: `npm install`. This will install all the necessary dependencies.
+
+4. Run the command `npm start` to start the Question Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
+
+5. To view Question Service documentation, go to http://localhost:3000/docs.
+
+6. Using applications like Postman, you can interact with the Question Service on port 3000. If you wish to change this, please update the `.env` file.

backend/question-service/README.md

@@ -0,0 +1,55 @@
+import express, { Request, Response } from "express";
+import dotenv from "dotenv";
+import swaggerUi from "swagger-ui-express";
+import yaml from "yaml";
+import fs from "fs";
+import cors from "cors";
+
+import connectDB from "./config/db.ts";
+import questionRoutes from "./src/routes/questionRoutes.ts";
+
+dotenv.config();
+
+const allowedOrigins = process.env.ORIGINS
+  ? process.env.ORIGINS.split(",")
+  : ["http://localhost:5173", "http://127.0.0.1:5173"];
+
+const file = fs.readFileSync("./swagger.yml", "utf-8");
+const swaggerDocument = yaml.parse(file);
+
+const app = express();
+
+if (process.env.NODE_ENV !== "test") {
+  connectDB();
+}
+
+app.use(cors({ origin: allowedOrigins, credentials: true }));
+app.options("*", cors({ origin: allowedOrigins, credentials: true }));
+
+// To handle CORS Errors
+// app.use((req: Request, res: Response, next: NextFunction) => {
+//   res.header("Access-Control-Allow-Origin", req.headers.origin); // "*" -> Allow all links to access
+
+//   res.header(
+//     "Access-Control-Allow-Headers",
+//     "Origin, X-Requested-With, Content-Type, Accept, Authorization",
+//   );
+
+//   // Browsers usually send this before PUT or POST Requests
+//   if (req.method === "OPTIONS") {
+//     res.header("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT, PATCH");
+//     return res.status(200).json({});
+//   }
+
+//   // Continue Route Processing
+//   next();
+// });
+
+app.use(express.json());
+app.use("/api/questions", questionRoutes);
+app.use("/docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
+app.get("/", (req: Request, res: Response) => {
+  res.status(200).json({ message: "Hello world from question service" });
+});
+
+export default app;

backend/question-service/app.ts

@@ -0,0 +1,20 @@
+import mongoose from "mongoose";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+const connectDB = async () => {
+  try {
+    if (process.env.MONGO_URI == undefined) {
+      throw new Error("MONGO_URI is undefined");
+    }
+
+    await mongoose.connect(process.env.MONGO_URI);
+    console.log("MongoDB connected");
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+};
+
+export default connectDB;

backend/question-service/config/db.ts

@@ -0,0 +1,14 @@
+import admin from "firebase-admin";
+
+admin.initializeApp({
+  credential: admin.credential.cert({
+    projectId: process.env.FIREBASE_PROJECT_ID,
+    privateKey: process.env.FIREBASE_PRIVATE_KEY?.replace(/\\n/g, "\n"),
+    clientEmail: process.env.FIREBASE_CLIENT_EMAIL,
+  } as admin.ServiceAccount),
+  storageBucket: process.env.FIREBASE_STORAGE_BUCKET,
+});
+
+const bucket = admin.storage().bucket();
+
+export { bucket };

backend/question-service/config/firebase.ts

@@ -0,0 +1,6 @@
+import multer from "multer";
+
+const storage = multer.memoryStorage();
+const upload = multer({ storage }).array("images[]");
+
+export { upload };