docs: add UML and architecture documentation (Mermaid)
- docs/README.md — index and short system overview - 01-architecture.md — context, per-service components, Gradle modules, authentication/authorization, web interceptors (flowcharts) - 02-deployment.md — deployment diagram, containers/env/volumes, build stages, nginx, update sequence - 03-domain-model.md — class diagrams for identity/academic/progress and web, ER model of all schemas (cross-schema references noted) - 04-sequences.md — 10 sequence diagrams (login, JWT check, forced password change, lab import, distribution, submission, defense, grades+publication, content publishing, group page aggregation) - 05-states.md — state diagrams for defense session, grade publication, lab status, content visibility, submission lifecycle, variant assignment, password MS git log --oneline -3
This commit is contained in:
10
README.md
10
README.md
@@ -2,6 +2,16 @@
|
||||
|
||||
Микросервисная система для проведения практических занятий (Kotlin + Spring Boot + PostgreSQL 18).
|
||||
|
||||
## Документация
|
||||
|
||||
UML- и архитектурные диаграммы (Mermaid) — в каталоге [`docs/`](docs/README.md):
|
||||
|
||||
- [Архитектура](docs/01-architecture.md) — контекст, компоненты, модули, аутентификация;
|
||||
- [Развёртывание](docs/02-deployment.md) — Docker, nginx, тома, обновление;
|
||||
- [Модель данных и классов](docs/03-domain-model.md) — диаграммы классов по сервисам и ER-модель;
|
||||
- [Диаграммы последовательностей](docs/04-sequences.md) — вход, импорт ЛР, раздача вариантов, сдача, защита, оценки, материалы;
|
||||
- [Диаграммы состояний](docs/05-states.md) — защита, публикация оценок и материалов, сдача, пароль.
|
||||
|
||||
## Модули
|
||||
|
||||
- `libs/common-http` — общий формат ошибок и обработчик исключений.
|
||||
|
||||
Reference in New Issue
Block a user