Fix question number bug

README.md

@@ -4,17 +4,20 @@
 
 2. Start docker
 
-3. Run `docker-compose up --build` to build and run images and containers
+3. For `frontend`, `ai-service`, `email-service`, `mongodb-database`, `user-service`, there is an `.env` file that is required. 
+    Follow the respective `README.md` located in those folders.
 
-4. Note: this does not start the api-gateway. Follow the relevant `./gateway/README.md`
+4. Run `docker-compose up --build` to build and run images and containers
 
 ## Developer guide
 
-As of the last update of this README, only the user-service and question-service have been dockerized. A respective `Dockerfile` has been created within each of their folders. This `Dockerfile` specifies the instructions in order to build the container, install the necessary node modules etc. 
+As of the last update of this README, all backend services, frontend and gateway have been dockerized. A respective `Dockerfile` has been created within each of folders. This `Dockerfile` specifies the instructions in order to build the container, install the necessary node modules etc. 
 
-To simplify the container building, a `docker-compose.yml` has been created in order to start both containers at once. This is achieved through running `docker compose build` and `docker compose up` to call both dockerfiles.
+To simplify the container building, a `docker-compose.yml` has been created in order to start both containers at once. This is achieved through running `docker-compose up --build` to call all the dockerfiles.
 
-The api-gateway requires more work, see https://dev.to/naseef012/create-a-microservices-app-with-dockerized-express-api-gateway-1kf9 for more information.
+Note that user-service requires a Supabase database and question-service requires a MongoDB database. The respective `README.md` should aid you in creating your own databases.
+
+Also, the ai-service requires your own OpenAi key and email-service requires an SMTP_PASSWORD to run locally. For ease of testing, do so on peerprep.ryanchuahj.com
 
 ## Finishing Development
 

backend/ai-service/README.md

@@ -0,0 +1,10 @@
+# Getting Started with Ai-service
+
+1. Run `npm install` to install all the dependencies
+
+2. Duplicate `.env.example` and rename the new file to `.env`. Add your own OpenAI API key.
+
+3. To run development server, do `npm run dev`
+
+4. Do `npm run build` to compile for production before running `npm start`
+

backend/email-service/README.md

@@ -4,7 +4,9 @@
 
 2. Duplicate `.env.example` and rename the new file `.env`
 
-3. Retrieve secrets from group chat. Search `EMAILSECRETS`.
+3. IMPORTANT: the SMTP_PASSWORD uses a secret key only available to developers. 
+    For testing, please contact the developers. 
+    Optionally, you can also test the email functionality on peerprep.ryanchuahj.com.
 
 4. Run `npm start` to start the service.
 

gateway/.env.example

@@ -0,0 +1,3 @@
+USER_SERVICE_URL="http://localhost:3001"
+QUESTION_SERVICE_URL="http://localhost:3002"
+RABBITMQ_URL="amqp://user:password@localhost:5672"

gateway/README.md

@@ -2,6 +2,6 @@
 
 1. Use command `npm install -g express-gateway` to install express gateway on your system.
 
-2. For deployment, edit the `serviceEndpoints` in `./config/gateway.config.yml` to accept env vars.
+2. Duplicate `.env.example` and rename the new file to `.env`.
 
 3. Enter the gateway directory and run `npm start` to start the api gateway server.