Service containerisation

.github/workflows/ci.yml

@@ -4,12 +4,17 @@ on:
   push:
     branches:
       - "*"
-  pull_request:
-    branches:
-      - "*"
 
 env:
   NODE_VERSION: 20
+  FIREBASE_PROJECT_ID: ${{ secrets.FIREBASE_PROJECT_ID }}
+  FIREBASE_PRIVATE_KEY: ${{ secrets.FIREBASE_PRIVATE_KEY }}
+  FIREBASE_CLIENT_EMAIL: ${{ secrets.FIREBASE_CLIENT_EMAIL }}
+  FIREBASE_STORAGE_BUCKET: ${{ secrets.FIREBASE_STORAGE_BUCKET }}
+  JWT_SECRET: ${{ secrets.JWT_SECRET }}
+
+permissions:
+  contents: read
 
 jobs:
   ci:
@@ -30,6 +35,16 @@ jobs:
       - name: Linting
         working-directory: ${{ matrix.service }}
         run: npm run lint
-      # - name: Tests
-      #   working-directory: ${{ matrix.service }}
-      #   run: npm test
+      - name: Set .env variables
+        working-directory: ${{ matrix.service }}
+        run: |
+          touch .env
+          echo "FIREBASE_PROJECT_ID=${{ env.FIREBASE_PROJECT_ID }}" >> .env
+          echo "FIREBASE_PRIVATE_KEY=${{ env.FIREBASE_PRIVATE_KEY }}" >> .env
+          echo "FIREBASE_CLIENT_EMAIL=${{ env.FIREBASE_CLIENT_EMAIL }}" >> .env
+          echo "FIREBASE_CLIENT_EMAIL=${{ env.FIREBASE_CLIENT_EMAIL }}" >> .env
+          echo "FIREBASE_STORAGE_BUCKET=${{ env.FIREBASE_STORAGE_BUCKET }}" >> .env
+          echo "JWT_SECRET=${{ env.JWT_SECRET }}" >> .env
+      - name: Tests
+        working-directory: ${{ matrix.service }}
+        run: npm test

.husky/pre-commit

@@ -0,0 +1,7 @@
+cd ./frontend && npm run lint && npm run test
+cd ..
+
+cd ./backend/user-service && npm run lint && npm run test
+cd ../..
+
+cd ./backend/question-service && npm run lint && npm run test

README.md

@@ -1,11 +1,31 @@
-[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/bzPrOe11)
+# CS3219 Project (PeerPrep) - AY2425S1 Group 28
 
-# CS3219 Project (PeerPrep) - AY2425S1
+## Setting up
 
-## Group: G28
+We will be using Docker to set up PeerPrep. Install Docker [here](https://docs.docker.com/get-started/get-docker).
 
-### Note:
+Follow the instructions in [here](./backend/README.md) first before proceeding.
 
-- You can choose to develop individual microservices within separate folders within this repository **OR** use individual repositories (all public) for each microservice.
-- In the latter scenario, you should enable sub-modules on this GitHub classroom repository to manage the development/deployment **AND** add your mentor to the individual repositories as a collaborator.
-- The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements.
+1. Build all the services (without using cache).
+
+```
+docker-compose build --no-cache
+```
+
+2. Run all the services (in detached mode).
+
+```
+docker-compose up -d
+```
+
+To stop all the services, use the following command:
+
+```
+docker-compose down
+```
+
+## Useful links
+
+- User Service: http://localhost:3001
+- Question Service: http://localhost:3000
+- Frontend: http://localhost:5173

backend/.env.sample

@@ -0,0 +1,16 @@
+# Credentials for MongoDB and Mongo Express.
+# Create a copy of this file and name it `.env`. Change the values accordingly.
+
+# MongoDB credentials
+MONGO_INITDB_ROOT_USERNAME=root
+MONGO_INITDB_ROOT_PASSWORD=example
+
+# Mongo Express credentials
+ME_CONFIG_BASICAUTH_USERNAME=admin
+ME_CONFIG_BASICAUTH_PASSWORD=password
+
+# Do not change anything below this line
+ME_CONFIG_MONGODB_ADMINUSERNAME=${MONGO_INITDB_ROOT_USERNAME}
+ME_CONFIG_MONGODB_ADMINPASSWORD=${MONGO_INITDB_ROOT_PASSWORD}
+
+ME_CONFIG_MONGODB_URL=mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@mongo:27017/

backend/README.md

@@ -0,0 +1,126 @@
+# PeerPrep Backend
+
+> Before proceeding to each microservice for more instructions:
+
+1. Set-up either a local or cloud MongoDB.
+
+2. Set-up Firebase.
+
+## Setting-up local MongoDB (only if you are using Docker)
+
+1. In the `backend` directory, create a copy of the `.env.sample` file and name it `.env`.
+
+2. To set up credentials for the MongoDB database, update `MONGO_INITDB_ROOT_USERNAME`, `MONGO_INITDB_ROOT_PASSWORD` of the `.env` file.
+
+3. Your local Mongo URI will be `mongodb://<MONGO_INITDB_ROOT_USERNAME>:<MONGO_INITDB_ROOT_PASSWORD>@mongo:27017/`. Take note of it as we will be using in the `.env` files in the various microservices later on.
+
+4. You can view the MongoDB collections locally using Mongo Express. To set up Mongo Express, update `ME_CONFIG_BASICAUTH_USERNAME` and `ME_CONFIG_BASICAUTH_PASSWORD`. The username and password will be the login credentials when you access Mongo Express at http://localhost:8081.
+
+## Setting-up cloud MongoDB (in production)
+
+> This guide references the [user-service README in the PeerPrep-UserService repository](https://github.com/CS3219-AY2425S1/PeerPrep-UserService/blob/main/user-service/README.md)
+
+1. Visit the MongoDB Atlas Site [https://www.mongodb.com/atlas](https://www.mongodb.com/atlas) and click on "Try Free".
+
+2. Sign Up/Sign In with your preferred method.
+
+3. You will be greeted with welcome screens. Feel free to skip them till you reach the Dashboard page.
+
+4. Create a Database Deployment by clicking on the green `+ Create` Button:
+
+![alt text](./GuideAssets/Creation.png)
+
+5. Make selections as followings:
+
+- Select Shared Cluster
+- Select `aws` as Provider
+
+![alt text](./GuideAssets/Selection1.png)
+
+- Select `Singapore` for Region
+
+![alt text](./GuideAssets/Selection2.png)
+
+- Select `M0 Sandbox` Cluster (Free Forever - No Card Required)
+
+> Ensure to select M0 Sandbox, else you may be prompted to enter card details and may be charged!
+
+![alt text](./GuideAssets/Selection3.png)
+
+- Leave `Additional Settings` as it is
+
+- Provide a suitable name to the Cluster
+
+![alt text](./GuideAssets/Selection4.png)
+
+![alt text](./GuideAssets/Security.png)
+
+7. Next, click on `Add my Current IP Address`. This will whitelist your IP address and allow you to connect to the MongoDB Database.
+
+![alt text](./GuideAssets/Network.png)
+
+8. Click `Finish and Close` and the MongoDB Instance should be up and running.
+
+9. [Optional] Whitelisting All IP's
+
+   1. Select `Network Access` from the left side pane on Dashboard.
+
+      ![alt text](./GuideAssets/SidePane.png)
+
+   2. Click on the `Add IP Address` Button
+
+      ![alt text](./GuideAssets/AddIPAddress.png)
+
+   3. Select the `ALLOW ACCESS FROM ANYWHERE` Button and Click `Confirm`
+
+      ![alt text](./GuideAssets/IPWhitelisting.png)
+
+   4. Now, any IP Address can access this Database.
+
+10. 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](GuideAssets/ConnectCluster.png)
+
+11. Select the `Drivers` option.
+
+    ![alt text](GuideAssets/DriverSelection.png)
+
+12. 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](GuideAssets/ConnectionString.png)
+
+13. Your cloud Mongo URI will be the string you copied earlier. Take note of it as we will be using in the `.env` files in the various microservices later on.
+
+## 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. You will need to update the following variables in the `.env` files of the various microservices later on.
+   - `FIREBASE_PROJECT_ID` is the value of `project_id` found in the downloaded json file.
+   - `FIREBASE_PRIVATE_KEY` is the value of `private_key` found in the downloaded json file.
+   - `FIREBASE_CLIENT_EMAIL` is the value of `client_email` found in the downloaded json file.
+   - `FIREBASE_STORAGE_BUCKET` is the folder path of the Storage. It should look something like `gs://<appname>.appspot.com`.

backend/question-service/.dockerignore

@@ -0,0 +1,5 @@
+coverage
+node_modules
+tests
+.env*
+*.md

backend/question-service/.env.sample

@@ -1,10 +1,13 @@
-MONGO_URI=MONGO_URI
+NODE_ENV=development
 
-FIREBASE_PROJECT_ID=FIREBASE_PROJECT_ID
-FIREBASE_PRIVATE_KEY=FIREBASE_PRIVATE_KEY
-FIREBASE_CLIENT_EMAIL=FIREBASE_CLIENT_EMAIL
-FIREBASE_STORAGE_BUCKET=FIREBASE_STORAGE_BUCKET
+MONGO_CLOUD_URI=<MONGO_CLOUD_URI>
+MONGO_LOCAL_URI=<MONGO_LOCAL_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
+USER_SERVICE_URL=http://user-service:3001/api

backend/question-service/Dockerfile

@@ -0,0 +1,13 @@
+FROM node:20-alpine
+
+WORKDIR /question-service
+
+COPY package*.json ./
+
+RUN npm ci
+
+COPY . .
+
+EXPOSE 3000
+
+CMD ["npm", "start"]

backend/question-service/README.md

@@ -1,71 +1,39 @@
 # Question Service
 
-## Setting-up MongoDB
+> If you have not set-up either a local or cloud MongoDB, as well as Firebase, visit [this](../README.md) before proceeding.
 
-> :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.
+## Setting-up Question Service
 
-1. Set up a MongoDB Shared Cluster by following the steps in this [Guide](../user-service/MongoDBSetup.md).
+1. In the `question-service` directory, create a copy of the `.env.sample` file and name it `.env`.
 
-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.
+2. To connect to your cloud MongoDB instead of your local MongoDB, set the `NODE_ENV` to `production` instead of `development`.
 
-   ![alt text](../user-service/GuideAssets/ConnectCluster.png)
+3. Update `MONGO_CLOUD_URI`, `MONGO_LOCAL_URI`, `FIREBASE_PROJECT_ID`, `FIREBASE_PRIVATE_KEY`, `FIREBASE_CLIENT_EMAIL`, `FIREBASE_STORAGE_BUCKET`.
 
-3. Select the `Drivers` option, as we have to link to a Node.js App (Question Service).
+## Running Question Service without Docker
 
-   ![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.
+1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
 
-4. After Storage is created, go to `Rules` section and set rule to:
+2. Open Command Line/Terminal and navigate into the `question-service` directory.
 
-   ```
-   rules_version = '2';
-   service firebase.storage {
-     match /b/{bucket}/o {
-       match /{allPaths=**} {
-         allow read: if true;
-         allow write: if request.auth != null;
-       }
-     }
-   }
-   ```
+3. Run the command: `npm install`. This will install all the necessary dependencies.
 
-   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.
+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. Go to `Settings`, `Project settings`, `Service accounts` and click `Generate new private key`. This will download a `.json` file, which will contain your credentials.
+## Seeding questions into MongoDB
 
-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`.
+1. With Docker
 
-## Running Question Service
+   - Run `docker ps` to get a list of the Docker containers on your machine.
+   - Retrieve the `CONTAINER_ID` of `peerprep/question-service`.
+   - Run `docker exec -it <CONTAINER_ID> npm run seed`.
 
-1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
+2. Without Docker
 
-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.
+   - Run `npm run seed`.
 
-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.
+## After running
 
-5. To view Question Service documentation, go to http://localhost:3000/docs.
+1. 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.
+2. 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/app.ts

@@ -5,7 +5,6 @@ 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();
@@ -19,10 +18,6 @@ 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 }));