Merge pull request #171 from CS3219-AY2324S1/add-readme

fix: assignment readme
CS3219-AY2324S1 · Nov 18, 2023 · f38f80c · f38f80c
2 parents 52cc531 + 4cf86e6
commit f38f80c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/Assignment1.md b/Assignment1.md
@@ -6,7 +6,7 @@
 | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | 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`.                                                                                                                                                                                 |
+| 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. |

diff --git a/Assignment5.md b/Assignment5.md
@@ -6,7 +6,7 @@
 | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | 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 and `frontend`.                                                                                                                                                             |
+| 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.                                                                                                                                                          |