docs: add full project documentation

- Architecture: overview, 7 ADR, tech stack
- Principles: code-style, git-workflow, security
- API contracts: auth, profile, tests, admin endpoints
- Database schema: tables, relationships, indexes
- LLM strategy: prompts, fallback, validation, Qwen 2.5 14B
- Onboarding: setup, Docker, .env template
- Progress: roadmap, changelog
- Agents: context, backend instructions

Made-with: Cursor
This commit is contained in:
Anton
2026-03-04 12:07:17 +03:00
commit 99cd8ae727
21 changed files with 3763 additions and 0 deletions

12
progress/changelog.md Normal file
View File

@@ -0,0 +1,12 @@
# Changelog
Формат: [дата] — краткое описание изменений.
---
## 2026-03-03
- Создана структура документации `samreshu-docs`
- Зафиксированы архитектурные решения (7 ADR)
- Описана схема БД
- Определён roadmap (MVP 0 → Phase 3)

82
progress/roadmap.md Normal file
View File

@@ -0,0 +1,82 @@
# Roadmap
## MVP 0 (текущая фаза)
Цель: рабочий продукт с базовым функционалом.
### Scope
- Регистрация / логин / выход
- Подтверждение email
- Восстановление пароля
- Профиль (никнейм, страна)
- Создание теста (стек + уровень + количество вопросов)
- Прохождение теста (вопросы, таймер, прогресс)
- Результаты (балл, разбор, объяснения)
- Базовая история (последние 10 тестов)
- LLM генерация вопросов + fallback на банк
- Минимальная админка (QA очередь вопросов)
### Стеки в MVP 0
- HTML
- CSS
### Уровни в MVP 0
- Базовый
- Начинающий
---
## Phase 1 — Платный запуск
Цель: монетизация, расширение контента.
- Все стеки (JS, TS, React, Vue, Node.js, Git, Web basics)
- Подписка Pro (ЮKassa)
- Trial 5 дней
- Лимиты Free / Pro
- Промокоды
---
## Phase 2 — Рост
Цель: удержание, расширение функционала.
- Рейтинги и лидерборд
- Аналитика Pro (статистика по темам, график прогресса)
- 2FA (TOTP)
- OAuth (GitHub + Google)
- Типы вопросов: Multiple select, Short text
- Пауза теста
---
## Phase 3 — Зрелость
Цель: продвинутый контент, каналы коммуникации.
- Код-задачи (Code reading, Bug fixing)
- Бесконечный режим и Марафон
- Telegram-бот
- Push-уведомления
- Достижения и бейджи
- Региональные цены
- CloudPayments (резервный провайдер)
---
## Product Vision (целевое состояние)
### Пользователи и роли
| Роль | Доступ |
|------|--------|
| Guest | Лендинг, описание тарифов, примеры вопросов |
| Free | Базовый функционал, 5 тестов/день, 3 стека |
| Pro | Полный функционал, безлимит, все стеки |
| Admin | Модерация контента, управление пользователями |
Полное описание целевого объёма — в стартовом брифе (`intro.md`). Все архитектурные решения MVP принимаются с оглядкой на эту картину.