docs: add readme.md

2026-05-09 11:07:26 +05:00
commit 33179353a3
1 changed files with 76 additions and 0 deletions
@@ -0,0 +1,76 @@
+# 🦆 Rubber Ducking as a Service (RDaaS)
+
+> **Rubber Ducking as a Service.** Дебажь код, выговаривайся и решай проблемы, не покидая браузер.
+
+**RDaaS** — это высокотехнологичное воплощение метода «утенка». Вместо того чтобы мучить коллег или говорить в пустоту, ты объясняешь проблему интерактивной уточке. Она внимательно слушает и крякает в ответ в нужные моменты, подталкивая твой мозг к озарению.
+
+---
+
+## ✨ Почему это круто?
+
+- **🔒 Zero Logs (Local-First):** Обработка голоса происходит только в твоем браузере через Web Audio API. Никаких серверов, никакой записи, полная приватность.
+- **⚡ High Performance:** Никаких тяжелых LLM и задержек API. Только чистый, эмпатичный «кря» мгновенно после того, как ты замолчал.
+- **🦆 Психотерапия для кода:** Уточка не осуждает твой `try-catch` с пустым блоком. Она просто слушает.
+
+---
+
+## 🛠 Tech Stack (MVP)
+
+- **Frontend:** [SvelteKit](https://kit.svelte.dev/) (Static Adapter).
+- **Logic:** [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API) для анализа аудиопотока и детекции тишины.
+- **Animation:** SVG + CSS Transitions (реактивность на громкость голоса).
+- **Storage:** `localStorage` для сохранения твоих локальных рекордов и настроек.
+
+---
+
+## 🗺 Roadmap
+
+### 📍 Phase 1: MVP (В разработке)
+
+_Core-механика взаимодействия пользователя и уточки._
+
+- [ ] **Voice Activity Detection (VAD):** Детектор тишины на клиенте (уточка понимает, когда ты закончил мысль).
+- [ ] **Auto-Quack Engine:** Система воспроизведения звуков `quack.wav` с рандомной вариацией тональности.
+- [ ] **Visual Feedback:** Анимированная SVG-уточка, реагирующая на амплитуду голоса.
+- [ ] **"I Solved It!" Button:** Кнопка для фиксации победы над багом (итерация счетчика рекордов).
+
+### 📍 Phase 2: Gamification (Local Only)
+
+_Добавление фана без необходимости бэкенда._
+
+- [ ] **Joke Achievements:** Система локальных ачивок («Полуночный ковбой», «Сеньор Помидор», «Кря-мастер»).
+- [ ] **Sound Themes:** Наборы звуков (8-bit, Метал, Сочувственный шепот).
+- [ ] **Debug Journal:** Локальное сохранение лога твоих побед (только текст, только в твоем браузере).
+
+### 📍 Phase 3: Expansion (Future)
+
+_Масштабирование и монетизация._
+
+- [ ] **Rust Backend (Axum):** Облачная синхронизация профиля и кросс-платформенные настройки.
+- [ ] **Duck Shop & Battle Pass:** Кастомизация (уточка-хакер, уточка в худи, скины за ачивки).
+- [ ] **IDE Extensions:** Плагины для VS Code и JetBrains для вызова уточки горячей клавишей.
+- [ ] **Local-First LLM:** Опциональное подключение микро-моделей (через WebGPU) для тех, кому нужно, чтобы уточка иногда задавала наводящие вопросы.
+
+---
+
+## 🚀 Как запустить локально
+
+```bash
+# Клонируй репозиторий
+git clone https://github.com/Ku6epXBOCTuK/rubber-duck.git
+
+# Установи зависимости
+npm install
+
+# Запусти dev-сервер
+npm run dev
+
+```
+
+---
+
+## 🤝 Contributing
+
+Если ты знаешь, как сделать "Кря" на 10% эффективнее или хочешь нарисовать новый скин для уточки — welcome в Pull Requests!
+
+> _Disclaimer: Проект не несет ответственности за осознание того, что баг всё это время был в опечатке в имени переменной._