Feedback

.github/workflows/cicd.yml

@@ -0,0 +1,117 @@
+name: CI/CD Pipeline
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+jobs:
+  build-frontend:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./peer-prep-fe/
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+          cache-dependency-path: "./peer-prep-fe/package-lock.json"
+      - name: Install dependencies
+        run: npm install
+      - name: Build frontend
+        run: npm run build --if-present
+      - name: Run tests
+        run: npm test -- --watch=false --browsers=ChromeHeadless
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{vars.DOCKER_USERNAME}}
+          password: ${{secrets.DOCKERHUB_TOKEN}}
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: ./peer-prep-fe
+          file: ./peer-prep-fe/Dockerfile
+          platforms: linux/arm64, linux/amd64
+          push: true
+          tags: ${{vars.DOCKER_USERNAME}}/${{github.event.repository.name}}:latest
+
+  build-backend:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.23
+      #      - name: Build backend using Docker
+      #        run: |
+      #          cd peer-prep-be
+      #          docker build -t peer-prep-backend:latest .
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{vars.DOCKER_USERNAME}}
+          password: ${{secrets.DOCKERHUB_TOKEN}}
+      #      - name: Push Docker image
+      #        run: docker push peer-prep-backend:latest
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: ./peer-prep-be
+          file: ./peer-prep-be/Dockerfile
+          platforms: linux/arm64, linux/amd64
+          push: true
+          tags: ${{vars.DOCKER_USERNAME}}/${{github.event.repository.name}}:latest
+      # - name: Test backend
+      #   run: |
+      #     cd peer-prep-be
+      #     go test -v ./main
+  # deploy:
+  #   needs: [build-frontend, build-backend]
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout code
+  #       uses: actions/checkout@v4
+  #     - name: Deploy Application
+  #       run: ./deploy.sh
+  build-mq:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./message-queue/
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm install
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{vars.DOCKER_USERNAME}}
+          password: ${{secrets.DOCKERHUB_TOKEN}}
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: ./message-queue
+          file: ./message-queue/Dockerfile
+          platforms: linux/arm64, linux/amd64
+          push: true
+          tags: ${{vars.DOCKER_USERNAME}}/${{github.event.repository.name}}:latest

.prettierrc.json

@@ -0,0 +1,31 @@
+{
+  "endOfLine": "lf",
+  "semi": false,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "none",
+  "bracketSameLine": true,
+  "printWidth": 120,
+  "importOrder": [
+    "^(react/(.*)$)|^(react$)",
+    "^(next/(.*)$)|^(next$)",
+    "<THIRD_PARTY_MODULES>",
+    "",
+    "^types$",
+    "^@/types/(.*)$",
+    "^@/config/(.*)$",
+    "^@/lib/(.*)$",
+    "^@/hooks/(.*)$",
+    "^@/components/ui/(.*)$",
+    "^@/components/(.*)$",
+    "^@/styles/(.*)$",
+    "^@/app/(.*)$",
+    "",
+    "^[./]"
+  ],
+  "importOrderParserPlugins": ["typescript", "jsx", "decorators-legacy"],
+  "plugins": [
+    "@ianvs/prettier-plugin-sort-imports",
+    "prettier-plugin-tailwindcss"
+  ]
+}

README.md

@@ -1,7 +1,86 @@
+[![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: Gxx
 
-### 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. 
+## Group: G01
+
+### Production:
+Deployed link: https://g01-peer-prep.vercel.app/
+
+Admin account (if needed): 
+- email: `[email protected]`
+- password: `123123`
+
+### Local (How to test): 
+
+#### Setting up: 
+1. Clone [our repo](https://github.com/CS3219-AY2425S1/cs3219-ay2425s1-project-g01.git) on your preferred IDE
+2. Open 2 terminals on your IDE (One for Frontend, One for Backend)
+3. Ensure you're on our latest commit on main branch
+4. Create `.env` files in the following directories, and populate them respectively:
+
+> [!NOTE]
+> The following section is solely for official testing in CS3219.
+
+> `peer-prep-be/`:
+> ```
+> MONGODB_URI=mongodb+srv://peer-prep:[email protected]/?retryWrites=true&w=majority&appName=peer-prep-cluster0
+> PORT=8080
+> ```
+> `message-queue/`
+> ```
+> AMQP_SERVER=amqps://lguugvwb:[email protected]/lguugvwb
+> MONGODB_URI=mongodb+srv://peer-prep:[email protected]/?retryWrites=true&w=majority&appName=peer-prep-cluster0
+> PORT=3002
+> ```
+> `peer-prep-collab/src/`:
+> ```
+> PORT=4003
+> MATCHING_SERVICE_URL=http://localhost:3002
+> QUESTIONS_SERVICE_URL=http://localhost:8080
+> DB_CLOUD_URI=mongodb+srv://peer-prep:[email protected]/?retryWrites=true&w=majority&appName=peer-prep-cluster0
+> ```
+> `peer-prep-user/user-service/`
+> ```
+> ENV=PROD
+> DB_CLOUD_URI=mongodb+srv://peer-prep:[email protected]/?retryWrites=true&w=majority&appName=peer-prep-cluster0
+> JWT_SECRET=you-can-replace-this-with-your-own-secret
+> ```
+
+#### Spin up backend
+Before proceeding to the following procedures, install Docker Desktop
+
+Run the docker containers by entering the following command in the root directory:
+```
+docker compose -f docker-compose.yml up -d
+```
+> [!WARNING]
+> Only one instance of containers should be running at any point in time.
+> That is, let your other friends know that they need to close theirs if you're testing!
+
+To close your containers, run the following command in the root directory:
+```
+docker compose -f docker-compose.yml down
+```
+
+#### Then, spin up the frontend 
+1. Install [Node](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+2. On your frontend terminal in the root folder (cs3219-ay2425s1-project-g01), navigate to the `peer-prep-fe` subfolder:
+```
+cd peer-prep-fe
+```
+3. Run the command `npm install` to install the required packages
+```
+npm install
+```
+4. Then, run the command `npm install -g @angular/cli`
+```
+npm install -g @angular/cli
+```
+5. Once done, run the command `ng serve` to start the local development server
+```
+ng serve
+```
+6. Once the following content appears in the terminal, the local development server has been successfully started
+<img width="500" alt="image" src="https://github.com/user-attachments/assets/d92add4f-63fa-4456-a62a-c2fdbd2d864c">
+

app.yaml

@@ -0,0 +1,8 @@
+runtime: nodejs16
+env: standard
+handlers:
+  - url: /
+    static_files: dist/peer-prep-fe/browser/index.html
+    upload: dist/peer-prep-fe/browser/index.html
+  - url: /
+    static_dir: dist/peer-prep-fe/browser

chat-websocket/.gitignore

@@ -0,0 +1 @@
+/node_modules

chat-websocket/Dockerfile

@@ -0,0 +1,20 @@
+# Use a Node.js base image
+FROM node:18
+
+# Create and set the working directory
+WORKDIR /app
+
+# Copy package.json and package-lock.json to the working directory
+COPY package*.json ./
+
+# Install dependencies
+RUN npm install
+
+# Copy the rest of the application files
+COPY . .
+
+# Expose the port the WebSocket server will run on
+EXPOSE 8082
+
+# Start the WebSocket server
+CMD ["node", "server.js"]

chat-websocket/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "chat-websocket",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "ws": "^8.18.0"
+  }
+}