Feedback

.github/workflows/frontend.yml

@@ -0,0 +1,25 @@
+name: Deploy frontend
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      REACT_APP_BACKEND_URL: ${{ secrets.REACT_APP_BACKEND_URL }}
+      REACT_APP_USER_SERVICE_BACKEND_URL: ${{ secrets.REACT_APP_USER_SERVICE_BACKEND_URL }}
+      REACT_APP_COLLABORATION_SERVICE_BACKEND_URL: ${{ secrets.REACT_APP_COLLABORATION_SERVICE_BACKEND_URL }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Dependencies and Build
+        run: |
+          cd frontend
+          export NODE_OPTIONS="--max_old_space_size=4096"
+          npm ci
+          npm run build

.github/workflows/question-service.yml

@@ -0,0 +1,24 @@
+name: Deploy question service
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      MONGO_CONNECTION_STRING: ${{ secrets.MONGO_CONNECTION_STRING }}
+      PORT: 8080
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Build the Docker image
+        run: docker build -t question-service -f backend/question-service/Dockerfile backend/question-service
+
+      - name: Run the Docker container with MongoDB
+        run: |
+          docker run -e MONGO_CONNECTION_STRING -e PORT -p $PORT:8080 -d question-service

.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.prettierignore

@@ -0,0 +1,3 @@
+# Ignore artifacts:
+build
+coverage

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "endOfLine": "lf"
+}

Assignment1.md

@@ -0,0 +1,18 @@
+# Assignment 1: CRUD Question Bank
+
+## To setup and execute
+
+| **Step** | **Description**                                                                                                                                                                                                                                                           |
+| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 1        | Download the zip file named `ay2324s1-course-assessment-g17-Assignment-1-updated.zip` from [Assignment-1-updated](https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g17/releases/tag/Assignment-1-updated).                                                   |
+| 2        | Unzip the file and navigate to the folder `ay2324s1-course-assessment-g17-Assignment-1-updated`.                                                                                                                                                                          |
+| 3        | Set up the environment variables in `.env` for `backend/question-service` and `frontend`. They can be found in our submission on Canvas for private variables.                                                                                                                                                                                 |
+| 4        | `cd` into `backend/question-service` and `frontend`. Run `npm install` to install the dependencies for `question-service` and `frontend`. Note: You may need to run `npm i --save-dev @types/cors` and `npm i --save-dev @types/express` should you encounter any errors. |
+| 5        | In `frontend` and `backend/question-service`, run `npm start`. Access the frontend by navigating to `localhost:3000` in your browser.                                                                                                                                     |
+| 6        | The question table on the landing page will be flashing at first. This is because all our questions in the final database are scraped from Leetcode, so it would take a while, as long as 3 minutes, to get and load all 2354 questions. Wait for the question table containing questions to appear on the landing page before performing CRUD. Note: You may have to wait again after creating, editing or deleting a question. We apologise for the inconvenience, and seek your understanding. |
+
+Before:
+<img width="1672" alt="Screenshot 2023-11-18 at 13 41 45" src="https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g17/assets/97394017/dbbfbcf9-8463-4d36-810d-b919f7dff1ca">
+
+After waiting:
+<img width="1672" alt="Screenshot 2023-11-18 at 13 50 03" src="https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g17/assets/97394017/5d4b858a-083e-4028-9170-f1d71652c222">

Assignment2.md

@@ -0,0 +1,52 @@
+# Assignment 2
+
+> [!IMPORTANT] 
+> As of late, the list of questions appear to take very long to load, as there are over 2000 being fetched. Please wait for a minute and a half if you see no questions on the question list page. We apologise for the inconvenience, and seek your understanding.
+
+## To set up and execute
+
+### Download
+Download the ZIP file named `ay2324s1-course-assessment-g17-Assignment-2-Updated.zip` from [Assignment-2-Updated](https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g17/releases/tag/Assignment-2-Updated).
+2. Unzip the file and navigate to the folder `ay2324s1-course-assessment-g17-Assignment-2-Updated`.
+
+### Include .env files
+3. Set up the environment for the question service, user service, and frontend by including the `.env` files for each, which have been submitted separately on CANVAS. Make sure they are `.env` files within the question service, user service, and frontend directories.
+
+### Install dependencies
+4. Change into each directory (`frontend`, `backend/question-service`, `backend/user-service`) and run `npm install` to install the dependencies for the question service, user service, and frontend.
+
+Note: You may need to run `npm i --save-dev @types/cors` and `npm i --save-dev @types/express` should you encounter any errors.
+
+### Set up postgresql
+5. Start the postgresql used by the frontend by running below on another terminal window. 
+
+```
+docker run --rm -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres;
+```
+
+6. Then navigate to the user service directory (i.e. `ay2324s1-course-assessment-g17-Assignment-2-Updated/ay2324s1-course-assessment-g17-Assignment-2-Updated/backend/user-service`) and run the following commands:
+
+```
+npx prisma db push
+npx prisma db seed
+```
+
+This will set up the postgresql database schema, and also seed the database with 1 ADMIN role user account, the "designated maintainer role" account, and 1 USER role user accounts, "registered users". Details for usernames and passwords below.
+
+```
+ADMIN role account details:
+username: admin_user
+password: admin_password 
+
+USER role account details:
+username: regular_user
+password: user_password
+```
+
+Other accounts signed up from the application interface are all USER role user accounts, "registered users". 
+
+## Finished set up
+7. `npm start` the question service, user service, and frontend.
+
+## Notes
+To see the user database, you can simply run the command `npx prisma studio`, which will open up an interface for you to easily view the user database.

Assignment3.md

@@ -0,0 +1,51 @@
+# Assignment 3
+
+> [!IMPORTANT] 
+> As of late, the list of questions appear to take very long to load, as there are over 2000 being fetched. Please wait for a minute and a half if you see no questions on the question list page. We apologise for the inconvenience, and seek your understanding.
+
+## To set up and execute
+
+### Download
+1. Download the ZIP file named `ay2324s1-course-assessment-g17-Assignment-3-updated.zip` from the [Assignment-3-updated](https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g17/releases/tag/Assignment-3-updated).
+2. Unzip the file and navigate to the folder `ay2324s1-course-assessment-g17-Assignment-3-updated`.
+
+### Include .env files
+3. Set up the environment for the question service, user service, and frontend by including the `.env` files for each, which have been submitted as: 
+`Assignment3-question-service-environmentVariables.txt`, 
+`Assignment3-user-service-environmentVariables.txt`, 
+`Assignment3-frontend-environmentVariables.txt` respectively.
+Make sure they are `.env` files within the question service, user service, and frontend directories.
+
+### Install dependencies
+4. Run `npm install` to install the dependencies for the question service, user service, and frontend.
+
+### Set up postgresql
+5. Start the postgresql used by the frontend by running below on another terminal window. 
+
+```
+docker run --rm -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres;
+```
+
+6. Then navigate to the user service directory (i.e. `ay2324s1-course-assessment-g17-Assignment-3-updated/ay2324s1-course-assessment-g17-Assignment-3-updated/backend/user-service`) and run the following commands:
+
+```
+npx prisma db push
+npx prisma db seed
+```
+
+This will set up the postgresql database schema, and also seed the database with 1 ADMIN role user account, the "designated maintainer role" account, and 1 USER role user accounts, "registered users". Details for usernames and passwords below.
+
+```
+ADMIN role account details:
+username: admin_user
+password: admin_password 
+
+USER role account details:
+username: regular_user
+password: user_password
+```
+
+Other accounts signed up from the application interface are all USER role user accounts, "registered users". 
+
+## Finished set up
+7. `npm start` the question service, user service, and frontend.

Assignment4.md

@@ -0,0 +1,60 @@
+# Assignment-4
+
+## To set up and execute
+
+1. Download and unzip the file for [Assignment 4](https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g17/archive/refs/tags/Assignment-4.zip). `cd` into it.
+2. Set up environment variables.
+   > The unredacted environment variable `MONGO_CONNECTION_STRING` can be found in our Canvas submission for private variables.
+
+- frontend
+  - Save the frontend variables under `frontend/.env`.
+    ```
+    REACT_APP_BACKEND_URL=http://localhost:8080/api
+    REACT_APP_USER_SERVICE_BACKEND_URL=http://localhost:8000/
+    ```
+- user-service
+
+  - Save the user-service variables twice in `backend/user-service/.env` and `backend/user-service/.env.docker`
+    - backend/user-service/.env.docker
+    ```
+    DATABASE_URL="postgresql://postgres:postgres@postgres:5432/peerprep?schema=public"
+    PORT=8000
+    JWT_SECRET="secret"
+    FRONTEND_URL="http://localhost:3000"
+    ```
+    - backend/user-service/.env
+      (need to change DATABASE_URL because we would not be in docker compose's network)
+    ```
+    DATABASE_URL="postgresql://postgres:postgres@localhost:5432/peerprep?schema=public"
+    PORT=8000
+    JWT_SECRET="secret"
+    FRONTEND_URL="http://localhost:3000"
+    ```
+
+- question-service
+  - Save the question-service variables under `backend/question-service/.env`
+    ```
+    MONGO_CONNECTION_STRING=<redacted>
+    PORT=8080
+    FRONTEND_URL="http://localhost:3000"
+    ```
+
+3. Actually run it with Docker.
+
+- Option 1 (recommended): Docker Compose
+  1. cd into all frontend/backend services and type `npm install`
+  2. `docker-compose up`
+- Option 2: Running individually with `docker`
+  1. Navigate to the folder of the zip file you unzipped previously.
+  2. `cd backend/question-service`
+  3. `docker build . -t question-service && docker run -p 8080:8080 -d question-service`
+  4. Open another terminal tab. Repeat step 1.
+  5. `cd backend/user-service`
+  6. `docker build . -t user-service && docker run -p 8000:8000 -d user-service`
+
+4. Testing
+
+- If you used option 1, the frontend should be up as well, navigate to http://localhost:3000 to see the results.
+- If you used option 2, you can use some curl commands to verify the services work
+  - Question service: `curl localhost:8080/api/questions/1`
+  - User service: `curl localhost:8000/currentUser`

Assignment5.md

@@ -0,0 +1,16 @@
+# Assignment 5: Queue for Matching
+
+## To set up and execute
+
+| **Step** | **Description**                                                                                                                                                                                                                                      |
+| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 1        | Download the zip file named `ay2324s1-course-assessment-Assignment-5.zip` from [Assignment-5-updated](https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g17/releases/tag/Assignment-5-updated).                                                          |
+| 2        | Unzip the file and navigate to the folder `ay2324s1-course-assessment-Assignment-5`.                                                                                                                                                                 |
+| 3        | Set up the environment variables in `.env` for each of the microservices in the `backend`, as well as, for the `frontend`. They can be found in our submission on Canvas for private variables.                                                                                                                                                             |
+| 4        | Run `npm install` to install the dependencies for each microservice and `frontend`. Note: You may need to run `npm i --save-dev @types/cors` and `npm i --save-dev @types/express` should you encounter any errors.                                  |
+| 5        | Run `brew install rabbitmq` to install RabbitMQ.                                                                                                                                                                                                     |
+| 6        | Run `rabbitmq-plugins enable rabbitmq_management` to enable the RabbitMQ management plugin.                                                                                                                                                          |
+| 7        | Run `brew services start rabbitmq` to start the RabbitMQ server.                                                                                                                                                                                     |
+| 8        | To ensure that the RabbitMQ server is running, navigate to `http://localhost:15672/` and login with the default credentials `guest` and `guest`. Note: If RabbitMQ is already running, you may want to run `brew services restart rabbitmq` instead. |
+| 9        | Run `npm start` and navigate to `http://localhost:3000/` to access the frontend.                                                                                                                                                                     |
+| 10       | Once a successful match is made, you can verify the queue is working by navigating to `http://localhost:15672/#/queues`. You should see the queue `match_results` if it is successful.                                                               |