99cd8ae727
- 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
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
# samreshu-docs
|
||
|
||
Документация проекта **samreshu** — веб-приложение для тестирования знаний по веб-технологиям с LLM-генерацией вопросов.
|
||
|
||
## Навигация
|
||
|
||
### Архитектура
|
||
|
||
- [Общая архитектура](architecture/overview.md) — стек, схема сервисов, принципы
|
||
- [ADR: Polyrepo](architecture/decisions/001-polyrepo.md)
|
||
- [ADR: Fastify](architecture/decisions/002-fastify.md)
|
||
- [ADR: Drizzle ORM](architecture/decisions/003-drizzle-orm.md)
|
||
- [ADR: PostgreSQL](architecture/decisions/004-postgresql.md)
|
||
- [ADR: LLM-абстракция](architecture/decisions/005-llm-abstraction.md)
|
||
- [ADR: VPS + Docker deploy](architecture/decisions/006-vps-docker-deploy.md)
|
||
- [ADR: Без shared-types репо](architecture/decisions/007-no-shared-types-repo.md)
|
||
|
||
### Принципы
|
||
|
||
- [Code style](principles/code-style.md) — соглашения по коду, конфиги линтеров
|
||
- [Git workflow](principles/git-workflow.md) — ветки, коммиты, PR
|
||
- [Безопасность](principles/security.md) — `TODO` rate limiting, CORS, auth security
|
||
|
||
### API
|
||
|
||
- [Контракты](api/contracts.md) — `TODO` REST endpoints, request/response форматы
|
||
|
||
### База данных
|
||
|
||
- [Схема](database/schema.md) — таблицы, связи, пояснения
|
||
|
||
### LLM
|
||
|
||
- [Стратегия](llm/strategy.md) — `TODO` провайдеры, fallback, банк вопросов, prompt engineering
|
||
|
||
### Прогресс
|
||
|
||
- [Roadmap](progress/roadmap.md) — фазы и MVP scope
|
||
- [Changelog](progress/changelog.md) — что сделано
|
||
|
||
### Онбординг
|
||
|
||
- [Настройка окружения](onboarding/setup.md) — как поднять проект локально
|
||
|
||
### AI-агенты
|
||
|
||
- [Контекст для агентов](agents/context.md) — общее описание проекта для AI-ассистентов
|
||
- [Инструкции для backend](agents/backend.md) — структура, порядок разработки, паттерны
|
||
|
||
## Репозитории
|
||
|
||
| Репо | Описание |
|
||
| ------ | ---------- |
|
||
| `samreshu-backend` | Fastify + TypeScript + Drizzle ORM |
|
||
| `samreshu-frontend` | React + TypeScript + Vite |
|
||
| `samreshu-docs` | Документация, ADR, прогресс |
|