You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,26 @@ Each application also has its own `tsconfig.json` file that extends the root con
40
40
41
41
Please refer to the TypeScript documentation for more details on the various compiler options and how to use them.
42
42
43
+
## Dockerisation
44
+
45
+
The applications in this project are containerized using Docker. Each application has its own `Dockerfile` that specifies how to build a Docker image for the application.
46
+
There is also a `docker-compose.yml` file that defines a multi-container setup for running the applications together.
47
+
48
+
Since the project is a monorepo setup, it's important to run your commands from the root, for the Dockerfiles to have the correct context.
49
+
50
+
To build the Docker images for the applications, you can use the following commands:
51
+
52
+
-`docker build -t <image_name> -f api/Dockerfile .`: Builds a Docker image for the API application.
53
+
-`docker build -t <image_name> -f client/Dockerfile .`: Builds a Docker image for the client application.
54
+
55
+
To run the apps using the `docker-compose` file, you can use the following command:
56
+
57
+
-`docker-compose up`: Starts the applications in a multi-container setup.
58
+
-`docker-compose down`: Stops and removes the containers.
59
+
-`docker-compose up --build`: Rebuilds the images and starts the containers.
60
+
-`docker-compose up -d api --build`: Starts only the API application in detached mode and rebuilds the image.
61
+
-`docker-compose up -d client --build`: Starts only the client application in detached mode and rebuilds the image.
62
+
43
63
## TODO
44
64
45
65
There are several aspects of the project that still need to be documented:
0 commit comments