Feedback

.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - "*"
+
+env:
+  NODE_VERSION: 20
+
+permissions:
+  contents: read
+
+jobs:
+  frontend-ci:
+    runs-on: ubuntu-latest
+    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: frontend
+        run: npm install
+      - name: Linting
+        working-directory: frontend
+        run: npm run lint
+      - name: Test
+        run: docker compose -f docker-compose-test.yml run --rm test-frontend
+      # - name: Build
+      #   run: docker compose -f docker-compose-prod.yml build frontend
+  backend-ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        service:
+          [
+            question-service,
+            user-service,
+            matching-service,
+            collab-service,
+            code-execution-service,
+            communication-service,
+            qn-history-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: backend/${{ matrix.service }}
+        run: npm install
+      - name: Linting
+        working-directory: backend/${{ matrix.service }}
+        run: npm run lint
+      - name: Test
+        env:
+          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 }}
+          ONE_COMPILER_KEY: ${{ secrets.ONE_COMPILER_KEY }}
+        run: docker compose -f docker-compose-test.yml run --rm test-${{ matrix.service }}
+      # - name: Build
+      #   run: docker compose -f docker-compose-prod.yml build ${{ matrix.service }}

.gitignore

@@ -0,0 +1,32 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+*.tsbuildinfo
+
+# Coverage
+coverage
+
+# Editor directories and files
+.vscode/*
+!.vscode/settings.json
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Environment files
+.env

.husky/pre-commit

@@ -0,0 +1,14 @@
+cd ./frontend
+npm run lint
+npm run test -- --maxWorkers=50%
+cd .. 
+
+cd ./backend/user-service 
+npm run lint
+npm run test -- --maxWorkers=50%
+cd ../..  
+
+cd ./backend/question-service
+npm run lint
+npm run test -- --maxWorkers=50%
+cd ../..

.vscode/settings.json

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

README.md

@@ -1,7 +1,67 @@
-# CS3219 Project (PeerPrep) - AY2425S1
-## Group: Gxx
+# CS3219 Project (PeerPrep) - AY2425S1 Group 28
 
-### Note: 
-- 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. 
+## Deployment
+
+We deployed PeerPrep on AWS ECS. It is accessible [here](http://peerprep-frontend-alb-1935920115.ap-southeast-1.elb.amazonaws.com/) (deprecated).
+
+## Setting up
+
+We will be using Docker to set up PeerPrep. Install Docker [here](https://docs.docker.com/get-started/get-docker).
+
+Follow the instructions in [here](./backend/README.md) first before proceeding.
+
+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
+```
+
+## Running in Production Mode
+
+1. Build all the services (without using cache).
+
+```
+docker-compose -f docker-compose-prod.yml build --no-cache
+```
+
+2. Run all the services (in detached mode).
+
+```
+docker-compose -f docker-compose-prod.yml up -d
+```
+
+To stop all the services, use the following command:
+
+```
+docker-compose -f docker-compose-prod.yml down
+```
+
+## Useful links
+
+- User Service: http://localhost:3001
+
+- Question Service: http://localhost:3000
+
+- Matching Service: http://localhost:3002
+
+- Collab Service: http://localhost:3003
+
+- Code Execution Service: http://localhost:3004
+
+- Communication Service: http://localhost:3005
+
+- Question History Service: http://localhost:3006
+
+- Frontend: http://localhost:5173

backend/README.md

@@ -0,0 +1,132 @@
+# PeerPrep Backend
+
+> Before proceeding to each microservice for more instructions:
+
+1. Set up cloud MongoDB if you are not using Docker. We recommend this if you are just testing out each microservice separately to avoid needing to manually set up multiple instances of local MongoDB. Otherwise, if you are using `docker-compose.yml` to run PeerPrep, check out the READMEs in the different backend microservices to set up the `.env` files for the local MongoDB instances.
+
+2. Set up Firebase.
+
+3. For the microservices that use Redis, to view the contents stored:
+
+   1. Go to [http://localhost:5540](http://localhost:5540).
+
+   2. Click on "Add Redis Database".
+
+   3. Enter `host.docker.internal` as the Host.
+
+   4. Enter the port used by the respective service:
+      - User Service: `6379`
+      - Collab Service: `6380`
+
+4. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
+
+## 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
+
+> For ease of testing, you can set up just one firebase to use across all the microservices that need it.
+
+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/code-execution-service/.dockerignore

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

backend/code-execution-service/.env.sample

@@ -0,0 +1,12 @@
+NODE_ENV=development
+SERVICE_PORT=3004
+
+# Origins for cors
+ORIGINS=http://localhost:5173,http://127.0.0.1:5173
+
+# Other service APIs
+QUESTION_SERVICE_URL=http://question-service:3000/api/questions
+
+# One Compiler configuration
+ONE_COMPILER_URL=https://onecompiler-apis.p.rapidapi.com/api/v1/run
+ONE_COMPILER_KEY=<ONE_COMPILER_KEY>

backend/code-execution-service/Dockerfile

@@ -0,0 +1,25 @@
+FROM node:20-alpine AS base
+
+WORKDIR /code-execution-service
+
+COPY package*.json .
+
+RUN npm ci
+
+COPY . .
+
+EXPOSE 3004
+
+# DEV
+
+FROM base AS dev
+
+CMD ["npm", "run", "dev"]
+
+# PROD
+
+FROM base AS prod
+
+RUN npm run build
+
+CMD ["npm", "start"]