Skip to content

Commit 58acfd7

Browse files
Merge branch 'update-readme' of https://github.com/CS3219-AY2526Sem1/cs3219-ay2526s1-project-g12 into update-readme
2 parents 8b402c6 + 1b568c3 commit 58acfd7

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,28 @@ uv sync
163163
uv run fastapi dev main.py
164164
```
165165

166+
## Running Locally
167+
168+
We support running our services as containers using docker compose
169+
170+
> Prerequisite
171+
> * Ensure that docker is installed
172+
> * Ensure 4 Redis instances and 3 PostgreSQL instance are setup for the various services
173+
174+
To startup the containers:
175+
176+
```
177+
docker compose up -d --build
178+
```
179+
180+
To tear everything down
181+
182+
```
183+
docker compose down
184+
```
185+
186+
187+
166188
### Note:
167189
- You are required to develop individual microservices within separate folders within this repository.
168190
- The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements.

0 commit comments

Comments
 (0)