190 lines
6.1 KiB
Markdown
190 lines
6.1 KiB
Markdown
# VoIdea — Голос Идей
|
||
|
||
## О проекте
|
||
|
||
**VoIdea** — гибридное приложение (мобильное + веб) для фиксации и проработки идей с помощью группового ИИ-анализа.
|
||
|
||
### Ключевые возможности
|
||
|
||
- 🎙️ Голосовой ввод идей
|
||
- 🤖 11 ИИ-агентов для анализа
|
||
- 🔄 Синхронизация между устройствами
|
||
- 🔒 Защита данных (шифрование AES-256)
|
||
- 🌐 Работа оффлайн (PWA)
|
||
|
||
---
|
||
|
||
## Структура проекта
|
||
|
||
`
|
||
voidea/
|
||
├── app/ # Код приложения
|
||
│ ├── agents/ # 11 системных агентов
|
||
│ ├── core/ # Ядро (config, base, security)
|
||
│ ├── models/ # Модели данных
|
||
│ ├── api/ # API endpoints
|
||
│ ├── services/ # Бизнес-логика
|
||
│ ├── integrations/ # Внешние сервисы (AI, OAuth)
|
||
│ └── design-tokens/ # Сгенерированные стили
|
||
├── docs/ # Документация
|
||
│ ├── blocks/ # Блоки проекта (00-rules, PLAN...)
|
||
│ ├── design-system/ # Дизайн-система (tokens.json)
|
||
│ ├── instructions/ # Инструкции для AI и людей
|
||
│ ├── specs/ # Спецификации
|
||
│ ├── adr/ # Architecture Decision Records
|
||
│ ├── backlog/ # Отложенные задачи
|
||
│ ├── runbook/ # Runbook для админа
|
||
│ └── insights/ # Наблюдения ObserverAgent
|
||
├── tests/ # Тесты
|
||
│ ├── unit/ # Модульные
|
||
│ └── integration/ # Интеграционные
|
||
├── CHANGELOG/ # История версий
|
||
└── project.json # Машиночитаемое описание
|
||
`
|
||
|
||
---
|
||
|
||
## Быстрый старт
|
||
|
||
### Для AI (OpenCode)
|
||
|
||
1. Прочитай docs/blocks/00-rules.md — это приоритет
|
||
2. Прочитай docs/instructions/00-system-prompt.md
|
||
3. Следуй плану в docs/blocks/PLAN.md
|
||
|
||
### Для разработчиков
|
||
|
||
1. Установи Python 3.12+
|
||
2. Установи PostgreSQL
|
||
3. Скопируй .env.example → .env
|
||
4. Заполни .env (см. комментарии)
|
||
5. pip install -r requirements.txt
|
||
6. lembic upgrade head
|
||
7. uvicorn app.main:app --reload --port 8020
|
||
|
||
---
|
||
|
||
## Конфигурация
|
||
|
||
### Переменные окружения
|
||
|
||
Все переменные описаны в .env.example:
|
||
|
||
`ash
|
||
# Core
|
||
PROJECT_NAME=VoIdea
|
||
PROJECT_VERSION=1.0.0
|
||
SERVER_PORT=8020
|
||
|
||
# Database
|
||
DB_HOST=localhost
|
||
DB_PORT=5432
|
||
DB_NAME=voidea
|
||
DB_USER=voidea
|
||
|
||
# AI
|
||
AI_YANDEX_KEY=
|
||
AI_GIGACHAT_KEY=
|
||
|
||
# OAuth
|
||
OAUTH_YANDEX_ID=
|
||
OAUTH_GOOGLE_ID=
|
||
`
|
||
|
||
Подробнее: .env.example
|
||
|
||
---
|
||
|
||
## Версионирование
|
||
|
||
Формат: MAJOR.MINOR.PATCH (SemVer)
|
||
|
||
- **MAJOR** (1.x.x): полный релиз, breaking changes
|
||
- **MINOR** (x.1.x): новый функционал
|
||
- **PATCH** (x.x.1): багфиксы
|
||
|
||
CHANGELOG хранится в CHANGELOG/ по версиям.
|
||
Подробнее: docs/blocks/VERSIONS.md
|
||
|
||
---
|
||
|
||
## Дизайн-система
|
||
|
||
Единый источник истины: docs/design-system/tokens.json
|
||
|
||
Включает:
|
||
- Цвета (primary, background, text, semantic)
|
||
- Типографика (font-family, size, weight)
|
||
- Отступы, радиусы, тени
|
||
- 3 темы: system (auto), dark, light
|
||
|
||
Генераторы:
|
||
- generators/css_generator.py → CSS Variables
|
||
- generators/swift_generator.py → Swift
|
||
- generators/kotlin_generator.py → Kotlin XML
|
||
|
||
---
|
||
|
||
## Агенты
|
||
|
||
### Системные агенты (автоматизация)
|
||
|
||
| Агент | Назначение |
|
||
|-------|-----------|
|
||
| DocAgent | Документация |
|
||
| AuditAgent | Соблюдение правил |
|
||
| SecurityAgent | Безопасность |
|
||
| SpecAgent | Версионирование |
|
||
| ObserverAgent | Наблюдение за пользователями |
|
||
| QATesterAgent | Функциональное тестирование |
|
||
| FixAgent | Исправление багов |
|
||
| UITestAgent | Визуальное тестирование |
|
||
| RolloutAgent | Постепенное развёртывание |
|
||
| EvolutionAgent | Саморазвитие |
|
||
| BacklogAgent | Управление задачами |
|
||
|
||
Запуск: автоматически (pre-commit, push, cron) или вручную (админ-панель).
|
||
|
||
### ИИ-агенты (анализ идей)
|
||
|
||
11 ролей: Координатор, Организатор, Бизнес-аналитик, Юрист, Финансовый консультант, Архитектор, Тестировщик, UI-дизайнер, SMM-специалист, Лайф-коуч, Эксперт по доступности.
|
||
|
||
Промпты: docs/agent_prompts.yaml
|
||
|
||
---
|
||
|
||
## Документация
|
||
|
||
| Документ | Описание |
|
||
|----------|----------|
|
||
| docs/blocks/00-rules.md | Правила проекта (приоритет) |
|
||
| docs/blocks/PLAN.md | План реализации |
|
||
| docs/blocks/AUDIT.md | Система аудита |
|
||
| docs/blocks/BACKLOG.md | Система задач |
|
||
| docs/blocks/VERSIONS.md | Правила версионирования |
|
||
| docs/blocks/GLOSSARY.md | Глоссарий |
|
||
| docs/instructions/ | Инструкции для AI и людей |
|
||
| docs/runbook/ | Runbook для администратора |
|
||
|
||
---
|
||
|
||
## Контакты
|
||
|
||
**Owner:**
|
||
**License:** AGPL-3.0
|
||
**Версия:**
|
||
|
||
---
|
||
|
||
## TODO: Перед началом разработки
|
||
|
||
- [ ] Установить PostgreSQL локально
|
||
- [ ] Создать виртуальное окружение
|
||
- [ ] Настроить .env
|
||
- [ ] Запустить Block 1: Core
|
||
|
||
---
|
||
|
||
*Обновлён: 2026-05-10*
|
||
*Этот файл самообновляется системными агентами*
|