Merge pull request #58 from CS3219-AY2324S1/staging

docs: make change to trigger workflow
CS3219-AY2324S1 · Nov 9, 2023 · c464c75 · c464c75
2 parents 06b440d + 533f0f2
commit c464c75
Show file tree

Hide file tree

Showing 6 changed files with 221 additions and 205 deletions.
diff --git a/backend/api-gateway/README.md b/backend/api-gateway/README.md
@@ -2,7 +2,7 @@
 
 ## Instructions to run
 
-- Please refer to the [README.md](../README.md) in the root of the project for instructions to run the API gateway service
+- Please refer to the [README.md](../README.md) in the root of the project for instructions to run the API gateway service.
 
 ## Making requests to the API gateway for inter-service communicatio
 

diff --git a/backend/collaboration-service/README.md b/backend/collaboration-service/README.md
@@ -13,4 +13,4 @@ If you need to add new environment variables, please add them to the following l
    1. If the value is a secret, leave it blank and store it with the team's vault (e.g. an API key, secret key, access token, ARN, etc.)
    2. If the value is not a secret, you can leave in the value in the `.env.example` file (e.g. http://localhost:8000, staging, 32, etc.)
 
-2. `/backend/collaboration-service/infra/index.ts` under the `Deploy an ECS Service on Fargate to host the application container` comment under the `env` object. For Pulumi to inject the appropriate environment variables during deployment.
+2. `/backend/collaboration-service/infra/index.ts` under the `Deploy an ECS Service on Fargate to host the application container` comment under the `env` object. For Pulumi to inject the appropriate environment variables during deployment.
diff --git a/backend/matching-service/README.md b/backend/matching-service/README.md
@@ -0,0 +1,16 @@
+# Matching Service
+
+## Instructions to run
+
+- Please refer to the [README.md](../README.md) in the root of the project for instructions to run the matching service
+
+## New environment variables
+
+If you need to add new environment variables, please add them to the following locations:
+
+1. `/backend/matching-service/app/.env.example` file and commit it. For others to run the service locally.
+
+   1. If the value is a secret, leave it blank and store it with the team's vault (e.g. an API key, secret key, access token, ARN, etc.)
+   2. If the value is not a secret, you can leave in the value in the `.env.example` file (e.g. http://localhost:8000, staging, 32, etc.)
+
+2. `/backend/matching-service/infra/index.ts` under the `Deploy an ECS Service on Fargate to host the application container` comment under the `env` object. For Pulumi to inject the appropriate environment variables during deployment.