Update documentation and clarify MVP status
- Revised the CLAUDE.md and README.md files to reflect the current MVP status, emphasizing completed features and intentionally omitted elements such as traffic limits and billing. - Enhanced clarity in the documentation regarding the architecture, tech stack, and user roles. - Removed the outdated roadmap section and streamlined references to tech stack decisions. - Updated API design documentation to clarify the absence of versioning in the MVP and the handling of configuration details.
This commit is contained in:
@@ -50,25 +50,15 @@ pnpm dev # проксирует /api, /hubs на localhost:8080
|
||||
- [Product Vision & Scope](docs/vision.md) — что мы строим и для кого
|
||||
- [Architecture](docs/architecture.md) — Clean Architecture, CQRS, интеграция, realtime, безопасность
|
||||
- [Domain Model](docs/domain-model.md) — сущности, связи, инварианты
|
||||
- [Tech Stack (ADR)](docs/tech-stack.md) — решения по стеку и их обоснование
|
||||
- [Tech Stack](docs/tech-stack.md) — используемые технологии
|
||||
- [Backend Conventions](docs/backend-conventions.md) — структура проекта, паттерны, стиль кода
|
||||
- [Frontend](docs/frontend.md) — стек фронтенда и структура
|
||||
- [Telegram Bot](docs/telegram-bot.md) — бот, привязка Telegram и passwordless-вход
|
||||
- [API Design](docs/api-design.md) — REST-эндпоинты и SignalR-контракты
|
||||
- [Roadmap](docs/roadmap.md) — этапы разработки (ретроспектива) + backlog
|
||||
|
||||
Пример переменных окружения (сид админа, БД, JWT, Telegram) — [`.env.example`](.env.example).
|
||||
Инструкции для AI-ассистента (Claude Code) — в [`CLAUDE.md`](CLAUDE.md).
|
||||
|
||||
## Статус
|
||||
|
||||
✅ **MVP реализован.** Backend (Clean Architecture, CQRS, 134 теста) и frontend (React SPA, полная
|
||||
админка) готовы, покрывают весь [roadmap](docs/roadmap.md) M0–M8: регистрация/активация/роли,
|
||||
управление нодами 3x-ui и inbound'ами, самообслуживание конфигами, realtime по SignalR, Telegram-бот
|
||||
(привязка + passwordless-вход + уведомления), админ-статистика и аудит. Единый Docker-образ и
|
||||
docker-compose стек проверены end-to-end. Что осталось за рамками MVP осознанно — раздел Backlog в
|
||||
[roadmap.md](docs/roadmap.md#backlog-после-mvp).
|
||||
|
||||
## Лицензия
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
Reference in New Issue
Block a user