dannc/spring-boot-demo
1
0
Fork 0
mirror of https://github.com/Dannecron/spring-boot-demo.git synced 2025-12-26 00:32:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

improve readme

Browse Source
This commit is contained in:
Denis Savosin
2024-10-11 13:13:51 +07:00
parent 80423338f5
commit ddff3675e8
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md
View File

@@ -7,6 +7,7 @@ Demo приложение для изучения языка `kotlin` и фре
* `jdk` версии `17`
* `postgresql` версии `14`
* `kafka` без авторизации
* `grafana-agent` (или аналогичный otlp-совместимый сборщик трейс-логов)
* `docker` + `compose`
## Доступные команды
@@ -16,6 +17,8 @@ Demo приложение для изучения языка `kotlin` и фре
./gradlew test
```
* после прохождения тестов можно увидеть [карту покрытия](/build/reports/jacoco/test/html/index.html).
* запуск приложения
```shell
./gradlew bootRun
@@ -23,6 +26,11 @@ Demo приложение для изучения языка `kotlin` и фре
## Запуск с docker-compose
Перед первым запуском необходимо:
* запустить отдельно контейнеры с postgres, kafka и grafana-agent (опционально)
* убедиться, что все запущенные контейнеры будут видеть контейнер с приложением (например, добавить везде сеть `spring-boot-demo_default`)
* скопировать [.env.example](/.env.example) в [.env](/.env) и изменить конфигурацию
Перед каждым запуском необходимо собрать приложение:
```shell
./gradlew assemble
@@ -30,5 +38,5 @@ Demo приложение для изучения языка `kotlin` и фре
Затем можно запускать контейнер:
```shell
docker compose up -d
docker compose up
```