Початок Роботи

Перед початком переконайтеся, що у вас встановлені Docker та Docker Compose. Для використання Makefile необхідно встановити GNU Make.

Ініціалізація Проекту

Для побудови, встановлення залежностей та запуску проекту виконайте:

make init

Налаштування

Режими роботи

Визначте режим роботи додатка через файл .env:

Режим розробки (dev): Надає детальний звіт про помилки. APP_ENV=dev # для режиму розробки

Режим виробництва (prod): Обмежує відображення інформації про помилки для безпеки. APP_ENV=prod # для режиму виробництва

Запуск Проекту

make down

Зупинка Проекту

make down

Тести

Запуск Unit-тестів

make test-unit

Звіт про покриття коду тестами

make test-unit-coverage

Статичний аналіз коду

Запуск Psalm

make psalm-check

Документація API

Для детального ознайомлення з API, його кінцевими точками, параметрами та відповідями, ви можете використовувати нашу Swagger документацію. /public/swagger.json