From 5720f71a1348280f26ed4b1fc958464950b5eb21 Mon Sep 17 00:00:00 2001 From: Lynnette Ong <103313573+lynnetteeee@users.noreply.github.com> Date: Thu, 14 Nov 2024 02:19:33 +0800 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 9021769c83..c5609d4161 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,34 @@ Admin account (if needed): 1. Clone [our repo](https://github.com/CS3219-AY2425S1/cs3219-ay2425s1-project-g01.git) on your preferred IDE 2. Open 2 terminals on your IDE (One for Frontend, One for Backend) 3. Ensure you're on our latest commit on main branch +4. Create `.env` files in the following directories, and populate them respectively: +> [!NOTE] +> The following section is solely for official testing in CS3219. + +`peer-prep-be/`: +``` +MONGODB_URI=mongodb+srv://peer-prep:1EjJPR5eiyIwhIql@peer-prep-cluster0.ftsoh.mongodb.net/?retryWrites=true&w=majority&appName=peer-prep-cluster0 +PORT=8080 +``` +`message-queue/` +``` +AMQP_SERVER=amqps://lguugvwb:UtQY1D0zOoX8s0ZvR4GunuRDk0xv8UuI@octopus.rmq3.cloudamqp.com/lguugvwb +MONGODB_URI=mongodb+srv://peer-prep:1EjJPR5eiyIwhIql@peer-prep-cluster0.ftsoh.mongodb.net/?retryWrites=true&w=majority&appName=peer-prep-cluster0 +PORT=3002 +``` +`peer-prep-collab/src/`: +``` +PORT=4003 +MATCHING_SERVICE_URL=http://localhost:3002 +QUESTIONS_SERVICE_URL=http://localhost:8080 +DB_CLOUD_URI=mongodb+srv://peer-prep:1EjJPR5eiyIwhIql@peer-prep-cluster0.ftsoh.mongodb.net/?retryWrites=true&w=majority&appName=peer-prep-cluster0 +``` +`peer-prep-user/user-service/` +``` +ENV=PROD +DB_CLOUD_URI=mongodb+srv://peer-prep:1EjJPR5eiyIwhIql@peer-prep-cluster0.ftsoh.mongodb.net/?retryWrites=true&w=majority&appName=peer-prep-cluster0 +JWT_SECRET=you-can-replace-this-with-your-own-secret +``` #### Spin up backend Before proceeding to the following procedures, install Docker Desktop