Merge pull request #338 from meysamhadeli/docs/update-documentation

docs: update documentation
This commit is contained in:
Meysam Hadeli 2025-04-30 17:00:25 +03:30 committed by GitHub
commit a1f12f7129
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 37 additions and 19 deletions

View File

@ -13,6 +13,7 @@
- [Husky](#husky) - [Husky](#husky)
- [Upgrade Nuget Packages](#upgrade-nuget-packages) - [Upgrade Nuget Packages](#upgrade-nuget-packages)
- [How to Run](#how-to-run) - [How to Run](#how-to-run)
- [Docker Compose](#docker-compose)
- [Build](#build) - [Build](#build)
- [Run](#run) - [Run](#run)
- [Test](#test) - [Test](#test)
@ -75,6 +76,14 @@ dotnet outdated -u
## How to Run ## How to Run
> ### Docker Compose
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:
```bash
docker-compose -f ./deployments/docker-compose/docker-compose.yaml up -d
```
> ### Build > ### Build
To `build` monolith app, run this command in the `root` of the project: To `build` monolith app, run this command in the `root` of the project:
```bash ```bash

View File

@ -13,6 +13,7 @@
- [Husky](#husky) - [Husky](#husky)
- [Upgrade Nuget Packages](#upgrade-nuget-packages) - [Upgrade Nuget Packages](#upgrade-nuget-packages)
- [How to Run](#how-to-run) - [How to Run](#how-to-run)
- [Docker Compose](#docker-compose)
- [Build](#build) - [Build](#build)
- [Run](#run) - [Run](#run)
- [Test](#test) - [Test](#test)
@ -76,6 +77,14 @@ dotnet outdated -u
## How to Run ## How to Run
> ### Docker Compose
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:
```bash
docker-compose -f ./deployments/docker-compose/docker-compose.yaml up -d
```
> ### Build > ### Build
To `build` all modules, run this command in the `root` of the project: To `build` all modules, run this command in the `root` of the project:
```bash ```bash

View File

@ -19,7 +19,7 @@ services:
ports: ports:
- "2113:2113" - "2113:2113"
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# postgres # postgres
@ -42,7 +42,7 @@ services:
volumes: volumes:
- postgres-data:/var/lib/postgresql/data - postgres-data:/var/lib/postgresql/data
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# Mongo # Mongo
@ -57,7 +57,7 @@ services:
ports: ports:
- 27017:27017 - 27017:27017
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# jaeger # jaeger
@ -76,7 +76,7 @@ services:
- "14318:4318" # OTLP http receiver for jaeger - "14318:4318" # OTLP http receiver for jaeger
# - "9411" # Accepts Zipkin spans - /api/v2/spans # - "9411" # Accepts Zipkin spans - /api/v2/spans
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# zipkin # zipkin
@ -89,7 +89,7 @@ services:
ports: ports:
- "9411:9411" - "9411:9411"
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# prometheus # prometheus
@ -114,7 +114,7 @@ services:
- "--web.enable-remote-write-receiver" - "--web.enable-remote-write-receiver"
# - "--log.level=debug" # - "--log.level=debug"
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# otel-collector # otel-collector
@ -140,7 +140,7 @@ services:
- "4318:4318" # OTLP http receiver - "4318:4318" # OTLP http receiver
- "55679:55679" # zpages extension - "55679:55679" # zpages extension
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# rabbitmq # rabbitmq
@ -155,7 +155,7 @@ services:
# volumes: # volumes:
# - rabbitmq:/var/lib/rabbitmq # - rabbitmq:/var/lib/rabbitmq
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# Redis # Redis
@ -167,7 +167,7 @@ services:
ports: ports:
- 6379:6379 - 6379:6379
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# node-exporter # node-exporter
@ -189,7 +189,7 @@ services:
ports: ports:
- "9101:9100" - "9101:9100"
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# grafana # grafana
@ -218,7 +218,7 @@ services:
- ./../configs/grafana/provisioning:/etc/grafana/provisioning - ./../configs/grafana/provisioning:/etc/grafana/provisioning
- ./../configs/grafana/dashboards:/var/lib/grafana/dashboards - ./../configs/grafana/dashboards:/var/lib/grafana/dashboards
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# tempo # tempo
@ -239,7 +239,7 @@ services:
- "24317:4317" # otlp grpc - "24317:4317" # otlp grpc
- "24318:4318" # otlp http - "24318:4318" # otlp http
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# loki # loki
@ -257,7 +257,7 @@ services:
volumes: volumes:
- ./../configs/loki-config.yaml:/etc/loki/local-config.yaml - ./../configs/loki-config.yaml:/etc/loki/local-config.yaml
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# elasticsearch # elasticsearch
@ -290,7 +290,7 @@ services:
- ${ELASTIC_HOST_PORT:-9200}:${ELASTIC_PORT:-9200} - ${ELASTIC_HOST_PORT:-9200}:${ELASTIC_PORT:-9200}
- 9300:9300 - 9300:9300
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# kibana # kibana
@ -307,7 +307,7 @@ services:
depends_on: depends_on:
- elasticsearch - elasticsearch
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# cadvisor # cadvisor
@ -327,7 +327,7 @@ services:
devices: devices:
- /dev/kmsg - /dev/kmsg
networks: networks:
- booking_modular_monolith - booking
####################################################### #######################################################
# booking-modular-monolith # booking-modular-monolith
@ -353,11 +353,11 @@ services:
- ASPNETCORE_Kestrel__Certificates__Default__Password=password - ASPNETCORE_Kestrel__Certificates__Default__Password=password
- ASPNETCORE_Kestrel__Certificates__Default__Path=/https/aspnetapp.pfx - ASPNETCORE_Kestrel__Certificates__Default__Path=/https/aspnetapp.pfx
networks: networks:
- booking_modular_monolith - booking
networks: networks:
booking_modular_monolith: booking:
name: booking_modular_monolith name: booking
driver: bridge driver: bridge
volumes: volumes: