Leonid Pershin
cdd67f8e2b
- Removed deprecated Telegram user ID configuration from `.env.example` and added a new setting for admin Telegram user IDs. - Updated `CLAUDE.md` to reflect the current MVP status, detailing completed features and testing coverage. - Enhanced `README.md` with quick start instructions for Docker setup and clarified project status. - Revised API design documentation to include updated error handling and request/response structures. - Improved frontend documentation to outline the project structure and technologies used.
34 lines
3.1 KiB
Markdown
34 lines
3.1 KiB
Markdown
# PnvPanel — Документация
|
||
|
||
**MVP реализован** (backend M0–M8 + полный frontend). Документация ниже описывает систему как она
|
||
реально построена, со сверенными по коду деталями — не первоначальный план. Расхождения с ранним
|
||
замыслом отмечены явно там, где это важно (например, домен изначально закладывал доменные события —
|
||
в реализации от них отказались в пользу прямых вызовов из CQRS-хендлеров, см. [architecture.md](architecture.md)).
|
||
|
||
Индекс. Читать в этом порядке для погружения:
|
||
|
||
1. **[Product Vision & Scope](vision.md)** — продукт, роли, пользовательские сценарии, границы MVP.
|
||
2. **[Architecture](architecture.md)** — Clean Architecture, слои, CQRS, интеграция с 3x-ui, realtime, безопасность, фоновые задачи.
|
||
3. **[Domain Model](domain-model.md)** — сущности, value objects, связи, инварианты, уведомления/аудит.
|
||
4. **[Tech Stack (ADR)](tech-stack.md)** — принятые решения по технологиям и их обоснование.
|
||
5. **[Backend Conventions](backend-conventions.md)** — структура решения, паттерны, соглашения по коду.
|
||
6. **[Frontend](frontend.md)** — стек, структура, работа с API и realtime.
|
||
7. **[Telegram Bot](telegram-bot.md)** — бот: ссылка на сайт, просмотр конфигов, passwordless-вход через привязку Telegram.
|
||
8. **[API Design](api-design.md)** — контракты REST и SignalR.
|
||
9. **[Roadmap](roadmap.md)** — ретроспектива по этапам (milestones) + backlog.
|
||
|
||
## Принятые решения
|
||
|
||
Ключевые развилки закрыты (полная таблица — в [tech-stack.md](tech-stack.md#принятые-решения-по-открытым-вопросам)):
|
||
|
||
- **CQRS** — собственный тонкий диспетчер (не MediatR).
|
||
- **Роли** — ровно одна роль на пользователя; квота = `MaxConfigs` роли.
|
||
- **Секреты нод** — ASP.NET Core Data Protection (шифрование at-rest).
|
||
- **Тарифы `Plan`** — backlog (в MVP конфиги без лимитов трафика/срока).
|
||
- **i18n** — RU + EN с первого дня (react-i18next).
|
||
- **Telegram** — long polling; только привязка аккаунта (signup из бота — backlog).
|
||
- **История трафика** — простая таблица + TTL-чистка.
|
||
- **Логирование** — Serilog.
|
||
|
||
Остаточные мелочи (не блокируют старт): значение TTL истории трафика, прод-синки Serilog, TTL токенов Telegram.
|