Приложение представляет собой реализацию индивидуального проекта
в рамках проектной деятельности вуза.
Проект состоит из двух основных модулей:
- backend: сервер, делится на еще несколько модулей
- commons - модуль для хранения различных компонентов, требуемых во всех модулях сразу. Обычно туда выносятся всякие enum'ы и прочие константы
- data - в нем происходит всё взаимодействие с бд.
- security - в нем происходит все описание безопасности системы, на какие пути и кому можно ходить, логика хеширования паролей и тд.
- services - в нем находится вся бизнес-логика(google it) приложения.
- rest - продолжение backend модуля, в котором находятся все конечные точки приложения, для соединения через REST API.
- frontend: веб-приложение на Angular.
Для запуска сервера нужно использовать команду gradlew bootRun
из папки backend (cd backend в консоли).
Либо с помощью запуска файла App.java с помощью Intellij Idea.
Для запуска отладчика нужно использовать команду npm run start
из папки frontend (cd frontend в консоли).
Для работы с приложением нужно создать бд с названием matcher.
Для того чтобы у всех была одна и та же версия бд в проекте подключен Liquibase.
Чтобы получить все написанные миграции на свою созданную бд, нужно перейти в консоли в модуль db_migrations (cd db_migrations)
и использовать команды:
Если у тебя Windows:
gradlew update -Puser=имя_пользователя_бд -Purl=адрес_бд:порт -Ppwd=пароль
Если у тебя Unix-based:
./gradlew update ...
Параметры можно не указывать если устраивают значения по умолчанию:
| Ключ | Значение |
|---|---|
| url | localhost:5432 |
| user | postgres |
| password | 123 |
P.S. Если ты гений и знаешь что такое Docker и как им пользоваться, то для тебя есть эксклюзивное предложение в виде Dockerfile скрипта, который поднимет бд одним кликом и накатит все доступные миграции.
Для того, чтобы посмотреть все доступные пути энд-поинтов и их модели данных, на сервере подключен Swagger.
Чтобы увидеть страницу документации, нужно запустить сервер и перейти по пути localhost:8080/swagger-ui/