ivanuil / informed-student-backend Goto Github PK

Проект реализован в рамках академии бэкенда Tinkoff. Представляет собой сервис для студентов позволяющий делится учебными материалами, обсуждать их, а также узнавать новости учебного заведения.

Фронтенд: GitHub

• Spring Boot

• PostgreSQL

• Minio

• Spring Security

• Quartz

• JUnit

• TestContainers

Стартовая страница сервиса, авторизация реализована с помощью:
Авторизация реализована с помощью Spring Security. Существует 3 роли пользователей: Administrator, Moderator, User; подробнее о ролях в разделе Roles

Посты принадлежат одной из категорий и предмету. Предметы относятся к одному из курсов (1-6).

Есть возможность оставлять анонимные комментарии, удалять комментарии и посты может автор или администратор.

У каждого пользователя есть небольшая публичная страница с личной информацией.

У администратора есть панель управления регулярно выполняемыми задачами через соответсвующую панель. Для регулярных задач использован Quartz.

Администратор может просмотреть список всех пользователей сервиса и забанить любого пользователя. Забаненный пользователь не может зайти на сервис или зарегистрироваться под теми же реквизитами.

1. Необходимо запустить .bat файл в папке docker (для Windows), что локально поднимет MinIO и Postgres.
2. Установить "dev" профиль Spring в среде разработки (по умолчанию логин и пароль админа: admin).

Для запуска сервера необходимо указать реквизиты для доступа к Postgres и MinIO, настройки SpringSecurity:

spring.datasource.username={Postgres username}
spring.datasource.password={Postgres password}

minio.datasource.username={MinIO username}
minio.datasource.password={MinIO password}

app.security.jwt.secret-key={Security key}
app.security.jwt.expiration-time={Key expiration time}

admin.username={Admin username}
admin.password={Admin password}

Security key можно сгенерировать на сайте: seanwasere.com/generate-random-hex/. Key expiration time - в миллисекундах, можно использовать значение 3600000 (6 часов). Admin username/password - логин и пароль администратора.

Команда локально запустит контейнер MinIO из репозитория Docker:

docker run -p 9000:9000 -p 9001:9001 quay.io/minio/minio server /data --console-address ":9001"

Реквизиты по умолчанию:

minioadmin:minioadmin

Команда запустит Postgres в контейнере

docker run --name {Container name} -e POSTGRES_USER={Postgres username} -e POSTGRES_PASSWORD={Postgres password} -e POSTGRES_DB=postgres -d postgres

Тестирование происходит с использованием тестовых контейнеров, требуется только запущенный Docker

Документация API доступна в Swagger. Для получения доступа ко всем end-point необходима авторизация через администратора.

Существует три роли пользователя: ADMINISTRATOR, MODERATOR, USER. Их права:

Любой зарегистрировавшийся пользователь получает роль USER. ADMINISTRATOR может создавать аккаунты MODERATOR'ов. ADMINISTRATOR существует только один, его реквизиты указываются при запуске.