Feedback

.env.sample

@@ -0,0 +1,33 @@
+# This is a sample environment configuration file.
+# Copy this file to .env and replace the placeholder values with your own.
+
+# Question Service
+QUESTION_DB_CLOUD_URI=<FILL-THIS-IN>
+QUESTION_DB_LOCAL_URI=mongodb://question-db:27017/question
+
+# User Service
+USER_DB_CLOUD_URI=<FILL-THIS-IN>
+USER_DB_LOCAL_URI=mongodb://user-db:27017/user
+
+# Match Service
+MATCH_DB_CLOUD_URI=<FILL-THIS-IN>
+MATCH_DB_LOCAL_URI=mongodb://match-db:27017/match
+
+# Collaboration Service
+COLLAB_DB_CLOUD_URI=<FILL-THIS-IN>
+COLLAB_DB_LOCAL_URI=mongodb://collaboration-db:27017/collaboration
+YJS_DB_CLOUD_URI=<FILL-THIS-IN>
+YJS_DB_LOCAL_URI=mongodb://collaboration-db:27017/room
+
+# History Service
+HISTORY_DB_CLOUD_URI=<FILL-THIS-IN>
+HISTORY_DB_LOCAL_URI=mongodb://history-db:27017/history
+
+# Broker
+BROKER_URL=amqp://broker:5672
+
+# Secret for creating JWT signature
+JWT_SECRET=you-can-replace-this-with-your-own-secret
+
+# Node environment
+NODE_ENV=development

.github/pull_request_template.md

@@ -0,0 +1,10 @@
+## Description
+
+Please include a summary of the changes made in this pull request.
+
+## Checklist
+
+- [ ] I have updated documentation
+- [ ] All tests passing
+
+## Screenshots (if applicable)

.github/workflows/backend.yml

@@ -0,0 +1,64 @@
+name: Deploy Backend Services
+
+on:
+  push:
+    branches: [ 'production' ]
+
+  workflow_dispatch:
+
+permissions:
+  id-token: write   # This is required for requesting the JWT
+  contents: read    # This is required for actions/checkout
+
+env:
+  AWS_REGION: ap-southeast-1
+  ECS_CLUSTER: backend-cluster
+
+jobs:
+  deploy:
+    name: Deploy Backend Service
+    runs-on: ubuntu-latest
+    environment: production
+
+    strategy:
+      matrix:
+        service: [ 'question', 'user', 'match', 'collaboration', 'history' ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Configure AWS credentials
+        id: aws-configure
+        uses: aws-actions/[email protected]
+        with:
+          role-to-assume: ${{ secrets.AWS_BACKEND_ROLE }}
+          role-session-name: GitHub_to_AWS_via_FederatedOIDC
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Login to AWS ECR
+        id: login-ecr
+        uses: aws-actions/[email protected]
+
+      - name: Build and push ${{ matrix.service }} image to AWS ECR
+        id: build-image
+        env:
+          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+          ECR_REPOSITORY: ${{ matrix.service }}
+          IMAGE_TAG: latest
+        run: |
+          echo "Building $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG"
+          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG ./services/${{ matrix.service }}
+          docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
+
+      - name: Update AWS Service (${{ matrix.service }}) # Trigger re-deployment with latest image
+        id: update-service
+        env:
+          ECS_SERVICE: ${{ matrix.service }}-service
+        run: |
+          echo "Updating $ECS_SERVICE for $ECS_CLUSTER"
+          aws ecs update-service \
+            --cluster $ECS_CLUSTER \
+            --service $ECS_SERVICE \
+            --force-new-deployment \
+            --region $AWS_REGION

.github/workflows/frontend.yml

@@ -0,0 +1,44 @@
+name: Deploy Frontend
+
+on:
+  push:
+    branches: [ 'production' ]
+
+  workflow_dispatch:
+
+permissions:
+  id-token: write   # This is required for requesting the JWT
+  contents: read    # This is required for actions/checkout
+
+env:
+  AWS_REGION: ap-southeast-1
+  S3_BUCKET_NAME: app.peerprep.org
+
+jobs:
+  deploy:
+    name: Deploy Frontend
+    runs-on: ubuntu-latest
+    environment: production
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure AWS credentials
+        id: aws-configure
+        uses: aws-actions/[email protected]
+        with:
+          role-to-assume: ${{ secrets.AWS_FRONTEND_ROLE }}
+          role-session-name: GitHub_to_AWS_via_FederatedOIDC
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Build frontend distribution
+        working-directory: frontend
+        run: npm ci && npm run build
+
+      - name: Sync distribution to S3
+        run: |
+          aws s3 sync ./frontend/dist/frontend/browser/ s3://$S3_BUCKET_NAME --delete
+
+      - name: Invalidate Cloudfront Cache
+        run: |
+          aws cloudfront create-invalidation --distribution-id ${{ secrets.AWS_CLOUDFRONT_ID }} --paths "/*"

.github/workflows/tests.yml

@@ -0,0 +1,61 @@
+## https://docs.github.com/en/actions
+name: CI
+
+# Controls when the workflow will run
+on:
+  push:
+    branches: [ 'main' ]
+  pull_request:
+    branches: [ 'main' ]
+    types: [ 'opened', 'reopened', 'synchronize'] 
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  node-version: '20.x'
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build-service:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        service: [frontend, services/user, services/match]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Install Node Modules
+        run: cd ${{ matrix.service }} && npm ci
+      - name: Linting
+        run: cd ${{ matrix.service }} && npm run lint
+      - name: Build App
+        run: cd ${{ matrix.service }} && npm run build
+
+
+  build-service-and-test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        service: [services/question, services/collaboration, services/history]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Install Node Modules
+        run: cd ${{ matrix.service }} && npm ci
+      - name: Linting
+        run: cd ${{ matrix.service }} && npm run lint
+      - name: Build App
+        run: cd ${{ matrix.service }} && npm run build
+      - name: Run tests
+        run: cd ${{ matrix.service }} && npm run test

.gitignore

@@ -0,0 +1,7 @@
+**/node_modules
+**/.env
+**/.idea
+# Vim temp files
+*~
+*.swp
+*.swo

README.md

@@ -1,7 +1,77 @@
+[![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: G03
+
+### 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.
+
+## Pre-requisites
+
+1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
+2. Clone the GitHub repository
+
+```
+git clone https://github.com/CS3219-AY2425S1/cs3219-ay2425s1-project-g03.git
+```
+
+## Getting Started
+
+**Step 1: Copy Environment Configuration File**
+
+To get started, copy the contents of `.env.sample` into a new `.env` file located at the root level of the project.
+
+**Step 2: Build the Docker containers**
+
+Next, run the following command to build the Docker containers.
+
+```bash
+docker compose -f compose.yml build --no-cache
+```
+
+**Step 3: Start the Docker containers**
+
+Once the build is complete, you can start the Docker containers.
+
+```bash
+docker compose -f compose.yml up -d
+```
+
+After spinning up the services, you may access the frontend client at `127.0.0.1:4200`. Specifically, you can navigate
+to the Question SPA at `127.0.0.1:4200/questions` and the login page at `127.0.0.1/account`.
+
+If you would like to spin up the services in development mode, you may use the following command. This enables hot
+reloading and exposes the ports for all microservices.
+
+```bash
+docker compose -f compose.yml -f compose.dev.yml up -d
+```
+
+| Service                      | Port |
+|------------------------------|------|
+| Frontend                     | 4200 |
+| API Gateway                  | 8080 |
+| Question Service             | 8081 |
+| User Service                 | 8082 |
+| Match Service                | 8083 |
+| Collaboration & Room Service | 8084 |
+| History Service              | 8085 |
+
+**Step 4: Stop the Docker containers**
+
+Once you are done, stop and remove the containers using:
+
+```bash
+docker compose down -v
+```
+
+Note that this will clear any data stored in volumes associated with the containers. If you would like to keep your
+data, you can run the command without the `-v` flag, which will remove the containers but retain the data in the volumes
+for future use.

compose.dev.yml

@@ -0,0 +1,77 @@
+services:
+  frontend:
+    volumes:
+      - /app/node_modules
+      - ./frontend:/app
+
+  question:
+    command: npm run dev
+    ports:
+      - 8081:8081
+    volumes:
+      - /app/node_modules
+      - ./services/question:/app
+
+  question-db:
+    ports:
+      - 27017:27017
+
+  user:
+    command: npm run dev
+    ports:
+      - 8082:8082
+    volumes:
+      - /app/node_modules
+      - ./services/user:/app
+
+  user-db:
+    ports:
+      - 27018:27017
+
+  match:
+    command: npm run dev
+    ports:
+      - 8083:8083
+    volumes:
+      - /app/node_modules
+      - ./services/match:/app
+
+  match-db:
+    ports:
+      - 27019:27017
+
+  collaboration:
+    command: npm run dev
+    ports:
+      - 8084:8084
+    volumes:
+      - /app/node_modules
+      - ./services/collaboration:/app
+
+  collaboration-db:
+    ports:
+      - 27020:27017
+
+  history:
+    command: npm run dev
+    ports:
+      - 8085:8085
+    volumes:
+      - /app/node_modules
+      - ./services/history:/app
+
+  history-db:
+    ports:
+      - 27021:27017
+
+  broker:
+    ports:
+      - 5672:5672
+
+  dozzle:
+    image: amir20/dozzle:latest
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+    ports:
+      - 8000:8080
+    restart: always