Merge pull request #55 from CS3219-AY2425S1/development

Service containerisation

Author: ruiqi7

.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/