Files
spring-boot-demo/readme.md
Denis Savosin ddff3675e8 improve readme
2024-10-11 13:13:51 +07:00

42 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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