Skip to content

Commit a1f12f7

Browse files
authored
Merge pull request #338 from meysamhadeli/docs/update-documentation
docs: update documentation
2 parents 4b4eca5 + c7a92d7 commit a1f12f7

File tree

3 files changed

+37
-19
lines changed

3 files changed

+37
-19
lines changed

1-monolith-architecture-style/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [Husky](#husky)
1414
- [Upgrade Nuget Packages](#upgrade-nuget-packages)
1515
- [How to Run](#how-to-run)
16+
- [Docker Compose](#docker-compose)
1617
- [Build](#build)
1718
- [Run](#run)
1819
- [Test](#test)
@@ -75,6 +76,14 @@ dotnet outdated -u
7576

7677
## How to Run
7778

79+
> ### Docker Compose
80+
81+
To run this app in `Docker`, use the [docker-compose.yaml](./deployments/docker-compose/docker-compose.yaml) and execute the below command at the `root` of the application:
82+
83+
```bash
84+
docker-compose -f ./deployments/docker-compose/docker-compose.yaml up -d
85+
```
86+
7887
> ### Build
7988
To `build` monolith app, run this command in the `root` of the project:
8089
```bash

2-modular-monolith-architecture-style/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [Husky](#husky)
1414
- [Upgrade Nuget Packages](#upgrade-nuget-packages)
1515
- [How to Run](#how-to-run)
16+
- [Docker Compose](#docker-compose)
1617
- [Build](#build)
1718
- [Run](#run)
1819
- [Test](#test)
@@ -76,6 +77,14 @@ dotnet outdated -u
7677

7778
## How to Run
7879

80+
> ### Docker Compose
81+
82+
To run this app in `Docker`, use the [docker-compose.yaml](./deployments/docker-compose/docker-compose.yaml) and execute the below command at the `root` of the application:
83+
84+
```bash
85+
docker-compose -f ./deployments/docker-compose/docker-compose.yaml up -d
86+
```
87+
7988
> ### Build
8089
To `build` all modules, run this command in the `root` of the project:
8190
```bash

2-modular-monolith-architecture-style/deployments/docker-compose/docker-compose.yaml

+19-19
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ services:
1919
ports:
2020
- "2113:2113"
2121
networks:
22-
- booking_modular_monolith
22+
- booking
2323

2424
#######################################################
2525
# postgres
@@ -42,7 +42,7 @@ services:
4242
volumes:
4343
- postgres-data:/var/lib/postgresql/data
4444
networks:
45-
- booking_modular_monolith
45+
- booking
4646

4747
#######################################################
4848
# Mongo
@@ -57,7 +57,7 @@ services:
5757
ports:
5858
- 27017:27017
5959
networks:
60-
- booking_modular_monolith
60+
- booking
6161

6262
#######################################################
6363
# jaeger
@@ -76,7 +76,7 @@ services:
7676
- "14318:4318" # OTLP http receiver for jaeger
7777
# - "9411" # Accepts Zipkin spans - /api/v2/spans
7878
networks:
79-
- booking_modular_monolith
79+
- booking
8080

8181
#######################################################
8282
# zipkin
@@ -89,7 +89,7 @@ services:
8989
ports:
9090
- "9411:9411"
9191
networks:
92-
- booking_modular_monolith
92+
- booking
9393

9494
#######################################################
9595
# prometheus
@@ -114,7 +114,7 @@ services:
114114
- "--web.enable-remote-write-receiver"
115115
# - "--log.level=debug"
116116
networks:
117-
- booking_modular_monolith
117+
- booking
118118

119119
#######################################################
120120
# otel-collector
@@ -140,7 +140,7 @@ services:
140140
- "4318:4318" # OTLP http receiver
141141
- "55679:55679" # zpages extension
142142
networks:
143-
- booking_modular_monolith
143+
- booking
144144

145145
#######################################################
146146
# rabbitmq
@@ -155,7 +155,7 @@ services:
155155
# volumes:
156156
# - rabbitmq:/var/lib/rabbitmq
157157
networks:
158-
- booking_modular_monolith
158+
- booking
159159

160160
#######################################################
161161
# Redis
@@ -167,7 +167,7 @@ services:
167167
ports:
168168
- 6379:6379
169169
networks:
170-
- booking_modular_monolith
170+
- booking
171171

172172
#######################################################
173173
# node-exporter
@@ -189,7 +189,7 @@ services:
189189
ports:
190190
- "9101:9100"
191191
networks:
192-
- booking_modular_monolith
192+
- booking
193193

194194
#######################################################
195195
# grafana
@@ -218,7 +218,7 @@ services:
218218
- ./../configs/grafana/provisioning:/etc/grafana/provisioning
219219
- ./../configs/grafana/dashboards:/var/lib/grafana/dashboards
220220
networks:
221-
- booking_modular_monolith
221+
- booking
222222

223223
#######################################################
224224
# tempo
@@ -239,7 +239,7 @@ services:
239239
- "24317:4317" # otlp grpc
240240
- "24318:4318" # otlp http
241241
networks:
242-
- booking_modular_monolith
242+
- booking
243243

244244
#######################################################
245245
# loki
@@ -257,7 +257,7 @@ services:
257257
volumes:
258258
- ./../configs/loki-config.yaml:/etc/loki/local-config.yaml
259259
networks:
260-
- booking_modular_monolith
260+
- booking
261261

262262
#######################################################
263263
# elasticsearch
@@ -290,7 +290,7 @@ services:
290290
- ${ELASTIC_HOST_PORT:-9200}:${ELASTIC_PORT:-9200}
291291
- 9300:9300
292292
networks:
293-
- booking_modular_monolith
293+
- booking
294294

295295
#######################################################
296296
# kibana
@@ -307,7 +307,7 @@ services:
307307
depends_on:
308308
- elasticsearch
309309
networks:
310-
- booking_modular_monolith
310+
- booking
311311

312312
#######################################################
313313
# cadvisor
@@ -327,7 +327,7 @@ services:
327327
devices:
328328
- /dev/kmsg
329329
networks:
330-
- booking_modular_monolith
330+
- booking
331331

332332
#######################################################
333333
# booking-modular-monolith
@@ -353,11 +353,11 @@ services:
353353
- ASPNETCORE_Kestrel__Certificates__Default__Password=password
354354
- ASPNETCORE_Kestrel__Certificates__Default__Path=/https/aspnetapp.pfx
355355
networks:
356-
- booking_modular_monolith
356+
- booking
357357

358358
networks:
359-
booking_modular_monolith:
360-
name: booking_modular_monolith
359+
booking:
360+
name: booking
361361
driver: bridge
362362

363363
volumes:

0 commit comments

Comments
 (0)