Update readme

Author: ruiqi7

README.md

@@ -4,15 +4,28 @@
 
 We will be using Docker to set up PeerPrep. Install Docker [here](https://docs.docker.com/get-started/get-docker).
 
-Follow the instructions in the [backend directory](./backend/) first before proceeding.
+Follow the instructions in [here](./backend/README.md) first before proceeding.
+
+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:
 
-Run: 
 ```
-docker-compose up --build
+docker-compose down
 ```
 
 ## Useful links
 
 - User Service: http://localhost:3001
 - Question Service: http://localhost:3000
-- Frontend: http://localhost:5173
+- Frontend: http://localhost:5173

backend/README.md

@@ -10,7 +10,7 @@
 
 3. Your local Mongo URI will be `mongodb://<MONGO_INITDB_ROOT_USERNAME>:<MONGO_INITDB_ROOT_PASSWORD>@mongo:27017/`. Take note of it as we will be using in the `.env` file in the various microservices later on.
 
-5. You can view the MongoDB collections locally using Mongo Express. To set up Mongo Express, update `ME_CONFIG_BASICAUTH_USERNAME` and `ME_CONFIG_BASICAUTH_PASSWORD`. The username and password will be the login credentials when you access Mongo Express at http://localhost:8081.
+4. You can view the MongoDB collections locally using Mongo Express. To set up Mongo Express, update `ME_CONFIG_BASICAUTH_USERNAME` and `ME_CONFIG_BASICAUTH_PASSWORD`. The username and password will be the login credentials when you access Mongo Express at http://localhost:8081.
 
 ## Setting-up cloud MongoDB (in production)
 
@@ -49,7 +49,6 @@
 
 ![alt text](./GuideAssets/Selection4.png)
 
-
 ![alt text](./GuideAssets/Security.png)
 
 7. Next, click on `Add my Current IP Address`. This will whitelist your IP address and allow you to connect to the MongoDB Database.
@@ -61,23 +60,26 @@
 9. [Optional] Whitelisting All IP's
 
    1. Select `Network Access` from the left side pane on Dashboard.
-   ![alt text](./GuideAssets/SidePane.png)
+
+      ![alt text](./GuideAssets/SidePane.png)
 
    2. Click on the `Add IP Address` Button
-   ![alt text](./GuideAssets/AddIPAddress.png)
+
+      ![alt text](./GuideAssets/AddIPAddress.png)
 
    3. Select the `ALLOW ACCESS FROM ANYWHERE` Button and Click `Confirm`
-   ![alt text](./GuideAssets/IPWhitelisting.png)
+
+      ![alt text](./GuideAssets/IPWhitelisting.png)
 
    4. Now, any IP Address can access this Database.
 
 10. After setting up, go to the Database Deployment Page. You would see a list of the Databases you have set up. Select `Connect` on the cluster you just created earlier.
 
-   ![alt text](GuideAssets/ConnectCluster.png)
+    ![alt text](GuideAssets/ConnectCluster.png)
 
 11. Select the `Drivers` option.
 
-   ![alt text](GuideAssets/DriverSelection.png)
+    ![alt text](GuideAssets/DriverSelection.png)
 
 12. Select `Node.js` in the `Driver` pull-down menu, and copy the connection string.
 

backend/question-service/.env.sample

@@ -1,7 +1,7 @@
 NODE_ENV=development
 
 MONGO_CLOUD_URI=<MONGO_CLOUD_URI>
-MONGO_LOCAL_URI=mongodb://root:example@mongo:27017/
+MONGO_LOCAL_URI=<MONGO_LOCAL_URI>
 
 FIREBASE_PROJECT_ID=<FIREBASE_PROJECT_ID>
 FIREBASE_PRIVATE_KEY=<FIREBASE_PRIVATE_KEY>

backend/question-service/README.md

@@ -1,6 +1,6 @@
 # Question Service
 
-> If you have not set-up either a local or cloud MongoDB, go [here](../) first before proceding.
+> If you have not set-up either a local or cloud MongoDB, go [here](../README.md) first before proceding.
 
 ## Setting-up Firebase
 
@@ -32,7 +32,9 @@
 
 1. In the `question-service` directory, create a copy of the `.env.sample` file and name it `.env`.
 
-2. Update `MONGO_CLOUD_URI`, `MONGO_LOCAL_URI`, `FIREBASE_PROJECT_ID`, `FIREBASE_PRIVATE_KEY`, `FIREBASE_CLIENT_EMAIL`, `FIREBASE_STORAGE_BUCKET`. 
+2. To connect to your cloud MongoDB instead of your local MongoDB, set the `NODE_ENV` to `production` instead of `development`.
+
+3. Update `MONGO_CLOUD_URI`, `MONGO_LOCAL_URI`, `FIREBASE_PROJECT_ID`, `FIREBASE_PRIVATE_KEY`, `FIREBASE_CLIENT_EMAIL`, `FIREBASE_STORAGE_BUCKET`.
    - `FIREBASE_PROJECT_ID` is the value of `project_id` found in the downloaded json file.
    - `FIREBASE_PRIVATE_KEY` is the value of `private_key` found in the downloaded json file.
    - `FIREBASE_CLIENT_EMAIL` is the value of `client_email` found in the downloaded json file.
@@ -53,10 +55,8 @@
 1. With Docker
 
    - Run `docker ps` to get a list of the Docker containers on your machine.
-   
    - Retrieve the `CONTAINER_ID` of `peerprep/question-service`.
-   
-   - Run `docker exec -it <CONTAINER_ID>  npm run seed`.
+   - Run `docker exec -it <CONTAINER_ID> npm run seed`.
 
 2. Without Docker
 

backend/question-service/config/db.ts

@@ -15,7 +15,6 @@ const connectDB = async () => {
     }
 
     await mongoose.connect(mongoDBUri);
-    console.log("MongoDB connected");
   } catch (error) {
     console.error(error);
     process.exit(1);

backend/question-service/server.ts

@@ -6,10 +6,12 @@ const PORT = process.env.PORT || 3000;
 if (process.env.NODE_ENV !== "test") {
   connectDB()
     .then(() => {
-      console.log("MongoDB connected");
+      console.log("MongoDB Connected!");
 
       app.listen(PORT, () => {
-        console.log(`Server running on port ${PORT}`);
+        console.log(
+          `Question service server listening on http://localhost:${PORT}`,
+        );
       });
     })
     .catch((err) => {

backend/user-service/.dockerignore

@@ -1,3 +1,4 @@
+coverage
 node_modules
 tests
 .env*

backend/user-service/README.md

@@ -1,14 +1,16 @@
 # User Service Guide
 
-> If you have not set-up either a local or cloud MongoDB, as well as Firebase, go [here](../) first before proceding.
+> If you have not set-up either a local or cloud MongoDB, as well as Firebase, go [here](../README.md) first before proceding.
 
 ## Setting-up
 
 1. In the `user-service` directory, create a copy of the `.env.sample` file and name it `.env`.
 
-2. Update `MONGO_CLOUD_URI`, `MONGO_LOCAL_URI`, `FIREBASE_PROJECT_ID`, `FIREBASE_PRIVATE_KEY`, `FIREBASE_CLIENT_EMAIL`, `FIREBASE_STORAGE_BUCKET`, `JWT_SECRET`. 
+2. To connect to your cloud MongoDB instead of your local MongoDB, set the `NODE_ENV` to `production` instead of `development`.
 
-3. A default admin account (`email: [email protected]` and `password: Admin@123`) wil be created. If you wish to change the default credentials, update them in `.env`. Alternatively, you can also edit your credentials and user profile after you have created the default account.
+3. Update `MONGO_CLOUD_URI`, `MONGO_LOCAL_URI`, `FIREBASE_PROJECT_ID`, `FIREBASE_PRIVATE_KEY`, `FIREBASE_CLIENT_EMAIL`, `FIREBASE_STORAGE_BUCKET`, `JWT_SECRET`.
+
+4. A default admin account (`email: [email protected]` and `password: Admin@123`) wil be created. If you wish to change the default credentials, update them in `.env`. Alternatively, you can also edit your credentials and user profile after you have created the default account.
 
 ## Running User Service without Docker
 

frontend/.dockerignore

@@ -1 +1,3 @@
+coverage
 node_modules
+*.md

frontend/src/contexts/AuthContext.tsx

@@ -56,7 +56,7 @@ const AuthProvider: React.FC<{ children?: React.ReactNode }> = (props) => {
         });
     } else {
       setUser(null);
-      setLoading(false);
+      setTimeout(() => setLoading(false), 500);
     }
   }, []);