mirror of
https://github.com/Dannecron/spring-boot-demo.git
synced 2025-12-25 16:22:35 +03:00
improve readme
This commit is contained in:
10
readme.md
10
readme.md
@@ -7,6 +7,7 @@ Demo приложение для изучения языка `kotlin` и фре
|
|||||||
* `jdk` версии `17`
|
* `jdk` версии `17`
|
||||||
* `postgresql` версии `14`
|
* `postgresql` версии `14`
|
||||||
* `kafka` без авторизации
|
* `kafka` без авторизации
|
||||||
|
* `grafana-agent` (или аналогичный otlp-совместимый сборщик трейс-логов)
|
||||||
* `docker` + `compose`
|
* `docker` + `compose`
|
||||||
|
|
||||||
## Доступные команды
|
## Доступные команды
|
||||||
@@ -16,6 +17,8 @@ Demo приложение для изучения языка `kotlin` и фре
|
|||||||
./gradlew test
|
./gradlew test
|
||||||
```
|
```
|
||||||
|
|
||||||
|
* после прохождения тестов можно увидеть [карту покрытия](/build/reports/jacoco/test/html/index.html).
|
||||||
|
|
||||||
* запуск приложения
|
* запуск приложения
|
||||||
```shell
|
```shell
|
||||||
./gradlew bootRun
|
./gradlew bootRun
|
||||||
@@ -23,6 +26,11 @@ Demo приложение для изучения языка `kotlin` и фре
|
|||||||
|
|
||||||
## Запуск с docker-compose
|
## Запуск с docker-compose
|
||||||
|
|
||||||
|
Перед первым запуском необходимо:
|
||||||
|
* запустить отдельно контейнеры с postgres, kafka и grafana-agent (опционально)
|
||||||
|
* убедиться, что все запущенные контейнеры будут видеть контейнер с приложением (например, добавить везде сеть `spring-boot-demo_default`)
|
||||||
|
* скопировать [.env.example](/.env.example) в [.env](/.env) и изменить конфигурацию
|
||||||
|
|
||||||
Перед каждым запуском необходимо собрать приложение:
|
Перед каждым запуском необходимо собрать приложение:
|
||||||
```shell
|
```shell
|
||||||
./gradlew assemble
|
./gradlew assemble
|
||||||
@@ -30,5 +38,5 @@ Demo приложение для изучения языка `kotlin` и фре
|
|||||||
|
|
||||||
Затем можно запускать контейнер:
|
Затем можно запускать контейнер:
|
||||||
```shell
|
```shell
|
||||||
docker compose up -d
|
docker compose up
|
||||||
```
|
```
|
||||||
Reference in New Issue
Block a user