Merge branch 'test-updated-merge' of https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g16 into test-updated-merge

Author: Aishwarya Nair

CollaborationService/README.md

@@ -163,6 +163,10 @@ Sample data for MatchedPair collection:
     - reconnect
 
     - disconnect
+  
+Note:
+
+> For other test, please refer to the project report appendix.
 
 
 #### Jest testing

Frontend/README.md

@@ -1,70 +1,23 @@
-# Getting Started with Create React App
+# Frontend Setup Guide
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Quick Start
 
-## Available Scripts
+1. Navigate to the `Frontend` Directory in Terminal or Powershell
 
-In the project directory, you can run:
+2. Build the Container.
 
-### `npm start`
+Command:
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+```
+docker-compose build frontend
+```
 
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
+3. Start the Container.
 
-### `npm test`
+Command:
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+```
+docker-compose up frontend
+```
 
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
-
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
-
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+4. Using your preferred Browser, you can go to the following URL `http://localhost:3001/` to see the frontend running.

Frontend/src/App.js

@@ -48,7 +48,9 @@ const AIChatWrapper = () => {
 
 const ChatWrapper = () => {
   const location = useLocation();
-  return location.pathname === "/collaboration" ? <CommunicationWindow /> : null;
+  return location.pathname === "/collaboration" ? (
+    <CommunicationWindow />
+  ) : null;
 };
 
 function App() {

Frontend/src/User/UserStateController.js

@@ -37,6 +37,8 @@ async function getUserAdminStatus() {
     const result = await getUserData(userId);
 
     console.log(result.data.user.isAdmin);
+
+    return result.data.user.isAdmin;
   }
 
   return false;

GptService/README.md

@@ -23,23 +23,28 @@
 
 #### Listening port
 
-http://localhost:3004
+http://localhost:3008
 
 
 #### Start the microservice on local machine by:
 
-1. Navigate to peerprep directory.
+1. Navigate to GptService directory.
 
-2. Insert your own GPT-API_KEY for the services in the `peer-prep\src\backend\gpt-service\config\config.js` file as below:
+2. Insert your own GPT-API_KEY for the services in the `GptService\config\config.js` file as below:
 
 ``` 
 const API_KEY = '<Your api key>';
 ```
+
+Warning:
+
+> Please do not publish your API key to public.
+
 
 3. Start the microservice in terminal using commands:
 
 ```
-cd peer-prep\src\backend\gpt-service
+cd GptService
 npm install
 npm start
 ```
@@ -50,7 +55,7 @@ npm start
 > [email protected] start
 > node server.js
 
-GPT service listening on port 3004
+GPT service listening on port 3008
 ```
 
 5. End generative AI service in terminal using `Ctrl+C`.
@@ -66,11 +71,11 @@ GPT service listening on port 3004
 
    Send **POST** request to:
 
-    `http://localhost:3004/generate` and specify post fields.
+    `http://localhost:3008/generate` and specify post fields.
 
    Example:
 
-   Url link: `http://localhost:3004`
+   Url link: `http://localhost:3008`
 
    For testing using Postman, enter data using the `Body` panel (2 methods are available):
 
@@ -115,11 +120,11 @@ GPT service listening on port 3004
    
    Send **DELETE** request to:
    
-   `http://localhost:3004/exitGpt`
+   `http://localhost:3008/exitGpt`
    
    Example:
    
-   `http://localhost:3004/exitGpt`
+   `http://localhost:3008/exitGpt`
 
    raw:
 
@@ -145,11 +150,11 @@ GPT service listening on port 3004
      
    Send **GET** request to:
    
-   `http://localhost:3004/getCache`
+   `http://localhost:3008/getCache`
    
    Example:
    
-   `http://localhost:3004/getCache`
+   `http://localhost:3008/getCache`
 
    raw:
 
@@ -190,7 +195,7 @@ GPT service listening on port 3004
 1. Test the service using terminal commands:
 
 ```
-cd peer-prep\src\backend\gpt-service
+cd GptService
 npm test
 ```
 
@@ -199,20 +204,24 @@ npm test
 
 **Note**:
 
-> Please delete the containers for other microservices.
+> Please ensure that there are no active container of the required services.
 
-1. Navigate to peerprep directory.
+1. Navigate to GptService directory.
 
-2. Insert your own GPT-API_KEY for the services in the `peer-prep\src\backend\gpt-service\config\config.js` file as below:
+2. Insert your own GPT-API_KEY for the services in the `GptService\config\config.js` file as below:
    
 ``` 
 const API_KEY = '<Your api key>';
 ```
+Warning:
+
+> Please do not publish your API key to public.
+
    
 3. Start the microservice in terminal using commands:
    
 ```
-cd peer-prep\src\backend\gpt-service
+cd GptService
 docker-compose up --build
 ```
 
@@ -221,7 +230,7 @@ docker-compose up --build
 ```
 > [email protected] start
 > node server.js
-> GPT service listening on port 3004
+> GPT service listening on port 3008
 ```
 
-5. End matching service in terminal using `Ctrl+C` twice.
+5. End GPT service in terminal using `Ctrl+C` twice.

HistoryService/README.md

@@ -9,18 +9,18 @@
 Command:
 
 ```
-docker-compose build
+docker-compose build history-service history-service-database
 ```
 
 3. Start the Containers.
 
 Command:
 
 ```
-docker-compose up
+docker-compose up history-service history-service-database
 ```
 
-4. Using Postman or a likewise app, you can connect to `localhost:3006` to send http (REST) queries.
+4. Using Postman or a likewise app, you can connect to `http://localhost:3006/history/` to send http (REST) queries.
 
 # Starting Containers Individually
 
@@ -34,7 +34,7 @@ docker-compose up
 
 Set up a Docker network using the following command, and ensure to use the same network name when starting the various services and databases later. (This step is important if you dont want to run via `docker-compose up` command)
 
-Command:
+Using Terminal, Run the following Command:
 
 ```
 docker network create -d bridge peer-prep-network
@@ -44,6 +44,8 @@ This command is to be run only for the initial set up, and once the network is s
 
 ## mySQL Container
 
+Navigate into `HistoryService` Directory
+
 First and foremost change the `databaseUrl` in the `Config/config.js` file to `127.0.0.1`
 
 Start by running this container first, else History Service will not be able to connect to Database.
@@ -64,7 +66,7 @@ docker exec -it history-service-database sh
 
 The above will open a terminal window for the mySql Docker Container, where `mysql` can be used.
 
-## History Service Server
+## History Service Microservice
 
 1. Navigate to the `HistoryService` Directory in Terminal or Powershell
 
@@ -83,3 +85,5 @@ Command:
 ```
 docker run --rm -p 3006:3006 -v $(pwd):/app -it --network peer-prep-network history-service
 ```
+
+Using Postman or a likewise app, you can connect to `http://localhost:3006/history/` to send http (REST) queries.