Merge pull request #32 from nicolelim02/chore/docs

Update readme

Author: guanquann

backend/question-service/README.md

@@ -58,12 +58,14 @@
 
 ## Running Question Service
 
-1. Open Command Line/Terminal and navigate into the `question-service` directory.
+1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
 
-2. Run the command: `npm install`. This will install all the necessary dependencies.
+2. Open Command Line/Terminal and navigate into the `question-service` directory.
 
-3. Run the command `npm start` to start the Question Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
+3. Run the command: `npm install`. This will install all the necessary dependencies.
 
-4. To view Question Service documentation, go to http://localhost:3000/docs.
+4. Run the command `npm start` to start the Question Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
 
-5. Using applications like Postman, you can interact with the Question Service on port 3000. If you wish to change this, please update the `.env` file.
+5. To view Question Service documentation, go to http://localhost:3000/docs.
+
+6. Using applications like Postman, you can interact with the Question Service on port 3000. If you wish to change this, please update the `.env` file.

backend/user-service/README.md

@@ -22,18 +22,20 @@
 
 5. In the `user-service` directory, create a copy of the `.env.sample` file and name it `.env`.
 
-6. Update the `DB_CLOUD_URI` of the `.env` file, and paste the string we copied earlier in step 4. 
+6. Update the `DB_CLOUD_URI` of the `.env` file, and paste the string we copied earlier in step 4.
 
 ## Running User Service
 
-1. Open Command Line/Terminal and navigate into the `user-service` directory.
+1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
 
-2. Run the command: `npm install`. This will install all the necessary dependencies.
+2. Open Command Line/Terminal and navigate into the `user-service` directory.
 
-3. If you are running the user service for the first time, run `npm run seed`, to seed the database with a default admin account. If you wish to change the default, please update the `.env` file. Alternatively, you can also edit your credentials and user profile after you have created the default account.
+3. Run the command: `npm install`. This will install all the necessary dependencies.
 
-4. Run the command `npm start` to start the User Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
+4. If you are running the user service for the first time, run `npm run seed`, to seed the database with a default admin account. If you wish to change the default, please update the `.env` file. Alternatively, you can also edit your credentials and user profile after you have created the default account.
 
-5. To view User Service documentation, go to http://localhost:3001/docs.
+5. Run the command `npm start` to start the User Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
 
-6. Using applications like Postman, you can interact with the User Service on port 3001. If you wish to change this, please update the `.env` file.
+6. To view User Service documentation, go to http://localhost:3001/docs.
+
+7. Using applications like Postman, you can interact with the User Service on port 3001. If you wish to change this, please update the `.env` file.