Merge pull request #74 from feliciagan/separate-db

separate mongodb instances for each service

Author: nicolelim02

backend/.env.sample

@@ -2,22 +2,12 @@
 
 > Before proceeding to each microservice for more instructions:
 
-1. Set-up either a local or cloud MongoDB.
+1. Set up cloud MongoDB if not using docker. We recommend this if you are just testing out each microservice separately to avoid needing to manually set up multiple instances of local MongoDB. Else, if you are using docker-compose.yml to run PeerPrep, check out the READMEs in the different backend microservices to set up the env for the local MongoDB instances.
 
-2. Set-up Firebase.
+2. Set up Firebase.
 
 3. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
 
-## Setting-up local MongoDB (only if you are using Docker)
-
-1. In the `backend` directory, create a copy of the `.env.sample` file and name it `.env`.
-
-2. To set up credentials for the MongoDB database, update `MONGO_INITDB_ROOT_USERNAME`, `MONGO_INITDB_ROOT_PASSWORD` of the `.env` file.
-
-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` files in the various microservices later on.
-
-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)
 
 > This guide references the [user-service README in the PeerPrep-UserService repository](https://github.com/CS3219-AY2425S1/PeerPrep-UserService/blob/main/user-service/README.md)
@@ -97,6 +87,8 @@
 
 ## Setting-up Firebase
 
+> For ease of testing, you can set up just one firebase to use across all the microservices that need it.
+
 1. Go to https://console.firebase.google.com/u/0/.
 
 2. Create a project and choose a project name. Navigate to `Storage` and click on it to activate it.

backend/README.md

@@ -1,5 +1,5 @@
 NODE_ENV=development
-PORT=3002
+SERVICE_PORT=3002
 
 ORIGINS=http://localhost:5173,http://127.0.0.1:5173
 

backend/matching-service/.env.sample

@@ -17,7 +17,7 @@ io.on("connection", (socket) => {
   handleWebsocketMatchEvents(socket);
 });
 
-const PORT = process.env.PORT || 3002;
+const PORT = process.env.SERVICE_PORT || 3002;
 
 if (process.env.NODE_ENV !== "test") {
   connectRabbitMq()

backend/matching-service/server.ts

@@ -1,8 +1,5 @@
 NODE_ENV=development
-PORT=3000
-
-MONGO_CLOUD_URI=<MONGO_CLOUD_URI>
-MONGO_LOCAL_URI=<MONGO_LOCAL_URI>
+SERVICE_PORT=3000
 
 FIREBASE_PROJECT_ID=<FIREBASE_PROJECT_ID>
 FIREBASE_PRIVATE_KEY=<FIREBASE_PRIVATE_KEY>
@@ -14,3 +11,22 @@ ORIGINS=http://localhost:5173,http://127.0.0.1:5173
 USER_SERVICE_URL=http://user-service:3001/api
 
 MONGO_URI_TEST=mongodb://mongo:mongo@test-mongo:27017/
+
+# if using cloud MongoDB, replace with actual URI (run service separately)
+MONGO_CLOUD_URI=<MONGO_CLOUD_URI>
+
+# if using local MongoDB (run service with docker-compose)
+## MongoDB credentials
+MONGO_INITDB_ROOT_USERNAME=root
+MONGO_INITDB_ROOT_PASSWORD=example
+
+## Mongo Express credentials
+ME_CONFIG_BASICAUTH_USERNAME=admin
+ME_CONFIG_BASICAUTH_PASSWORD=password
+
+## Do not change anything below this line
+ME_CONFIG_MONGODB_ADMINUSERNAME=${MONGO_INITDB_ROOT_USERNAME}
+ME_CONFIG_MONGODB_ADMINPASSWORD=${MONGO_INITDB_ROOT_PASSWORD}
+ME_CONFIG_MONGODB_URL=mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@question-service-mongo:27017/
+
+MONGO_LOCAL_URI=mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@question-service-mongo:27017/

backend/question-service/.env.sample

@@ -8,10 +8,14 @@
 
 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`.
+3. Update `FIREBASE_PROJECT_ID`, `FIREBASE_PRIVATE_KEY`, `FIREBASE_CLIENT_EMAIL`, `FIREBASE_STORAGE_BUCKET`, `MONGO_CLOUD_URI` with the env variables obtained from following the instructions in the backend README. Then update `MONGO_INITDB_ROOT_USERNAME`, `MONGO_INITDB_ROOT_PASSWORD` to change your MongoDB credentials if necessary.
+
+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.
 
 ## Running Question Service without Docker
 
+> Make sure you have the cloud MongoDB URI in your .env file and set NODE_ENV to production already.
+
 1. Open Command Line/Terminal and navigate into the `question-service` directory.
 
 2. Run the command: `npm install`. This will install all the necessary dependencies.

backend/question-service/README.md

@@ -1,7 +1,7 @@
 import app from "./app.ts";
 import connectDB from "./config/db.ts";
 
-const PORT = process.env.PORT || 3000;
+const PORT = process.env.SERVICE_PORT || 3000;
 
 if (process.env.NODE_ENV !== "test") {
   connectDB()

backend/question-service/server.ts

@@ -1,8 +1,5 @@
 NODE_ENV=development
-PORT=3001
-
-MONGO_CLOUD_URI=<MONGO_CLOUD_URI>
-MONGO_LOCAL_URI=<MONGO_LOCAL_URI>
+SERVICE_PORT=3001
 
 # Secret for creating JWT signature
 JWT_SECRET=<JWT_SECRET>
@@ -34,4 +31,23 @@ REDIS_URI=redis://redis:6379 # Uncomment if you're running the user service usin
 
 # Test
 MONGO_URI_TEST=mongodb://mongo:mongo@test-mongo:27017/
-REDIS_URI_TEST=redis://test-redis:6379
+REDIS_URI_TEST=redis://test-redis:6379
+
+# if using cloud MongoDB, replace with actual URI (run service separately)
+MONGO_CLOUD_URI=<MONGO_CLOUD_URI>
+
+# if using local MongoDB (run service with docker-compose)
+## MongoDB credentials
+MONGO_INITDB_ROOT_USERNAME=root
+MONGO_INITDB_ROOT_PASSWORD=example
+
+## Mongo Express credentials
+ME_CONFIG_BASICAUTH_USERNAME=admin
+ME_CONFIG_BASICAUTH_PASSWORD=password
+
+## Do not change anything below this line
+ME_CONFIG_MONGODB_ADMINUSERNAME=${MONGO_INITDB_ROOT_USERNAME}
+ME_CONFIG_MONGODB_ADMINPASSWORD=${MONGO_INITDB_ROOT_PASSWORD}
+ME_CONFIG_MONGODB_URL=mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@user-service-mongo:27017/
+
+MONGO_LOCAL_URI=mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@user-service-mongo:27017/

backend/user-service/.env.sample

@@ -12,8 +12,6 @@
 
    - `MONGO_CLOUD_URI`
 
-   - `MONGO_LOCAL_URI`
-
    - `FIREBASE_PROJECT_ID`
 
    - `FIREBASE_PRIVATE_KEY`
@@ -32,9 +30,13 @@
 
    - `REDIS_URI`
 
-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.
+   You can also update `MONGO_INITDB_ROOT_USERNAME`, `MONGO_INITDB_ROOT_PASSWORD` to change your MongoDB credentials if necessary.
+
+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:8082.
 
-5. To view the contents stored in Redis,
+5. 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.
+
+6. To view the contents stored in Redis,
 
    1. Go to [http://localhost:5540](http://localhost:5540).
 
@@ -44,6 +46,8 @@
 
 ## Running User Service Individually
 
+> Make sure you have the cloud MongoDB URI in your .env file and set NODE_ENV to production already.
+
 1. Set up and run Redis using `docker compose run --rm --name redis -p 6379:6379 redis`.
 
 2. Open Command Line/Terminal and navigate into the `user-service` directory.

backend/user-service/README.md

@@ -7,7 +7,7 @@ import { connectRedis } from "./config/redis.ts";
 
 dotenv.config();
 
-const port = process.env.PORT || 3001;
+const port = process.env.SERVICE_PORT || 3001;
 
 const server = http.createServer(index);