Skip to content

Commit 3127480

Browse files
committed
Update README.md
1 parent c870039 commit 3127480

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,48 @@
1-
[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/6BOvYMwN)
1+
# Getting Started
22

3-
# AssignmentTemplate
3+
## Prerequisites
4+
5+
Install [Docker](https://www.docker.com/)
6+
7+
## Cloning the Repository
8+
9+
1. Open Terminal and navigate to the directory of your choice
10+
11+
```
12+
cd path/to/directory
13+
```
14+
15+
2. Clone the repository into that directory
16+
17+
```
18+
git clone https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g16.git
19+
```
20+
21+
## Build and Run on Local Docker Environment
22+
23+
Ensure that Docker and Docker Engine is up and running in your system.
24+
25+
1. Run the following command to build the containers.
26+
27+
```
28+
docker-compose build
29+
```
30+
31+
2. Run the following command to start the various services and frontend
32+
33+
```
34+
docker-compose up
35+
```
36+
37+
3. Now you can access the frontend of the application at `http://localhost:3001/`
38+
39+
4. For subsequent starts, you may skip the building step and run the `docker-compose up` command
40+
41+
5. To shut down the application, open a new Terminal and run the following command to graciously shut down these containers.
42+
43+
```
44+
docker-compose down
45+
```
446

547
# Service Status
648

0 commit comments

Comments
 (0)