brenscrazy / venue

Данный проект реализует приложение, необходимое для взаимодействия различных заведений (клубы, бары) с посетителями.

Venue application REST API

Описание

Данный проект реализует приложение, необходимое для взаимодействия различных заведений (клубы, бары) с посетителями.

Модель данных

Стек технологий

Безопасность

• Spring Security
• JWT Token Authentication

Хранение данных

• PostgreSQL
• Spring Data JPA
• Flyway DB migrations

Сервер

• Java 17
• Spring Web

Тестирование

• JUnit 4
• WebTestClient
• Mockito

Документация

• OpenAPI Swagger

Сборка и запуск

• Docker
• Maven

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

• Документация в формате HTML
• OpenAPI документация в формате JSON

Инструкция к запуску

Через Docker

Запустите из корня приложения следующие консольные команды:

./mvnw clean package -DskipTests
docker compose up

Самостоятельно

• Запустите PostgreSQL сервер в соотвтетствии с конфигурацией. Стандартно ожидается, что будет создана база данных "venue" на PostgreSQL сервере с портом 5432. Имя пользователя - postgres, пароль - 123.
• Запустите Java-приложение удобным для вас способом. К примеру, через IntelliJ IDEA, или собрав и запустив проект самостоятельно:

./mvnw clean package -DskipTests
java -jar ./target/venue-0.0.1-SNAPSHOT.jar

После запуска вы можете взаимодействовать с API через Swagger по ссылке http://localhost:8080/swagger-ui/index.html