docs(init): initialize repository, roadmap plan, and pedagogical guide for network english

2026-09-22 12:51:36 +00:00
commit 4631de5391
4 changed files with 292 additions and 0 deletions
@@ -0,0 +1,57 @@
+# Notes (notes.qpid.pro)
+
+> **Персональный тренажёр и словарь технического английского языка для сетевого инженера.**  
+> Создан для быстрого снятия языкового барьера при чтении RFC, документации Cisco/Juniper, Linux networking и технических статей.
+
+---
+
+## 🎯 Миссия проекта
+При чтении технической документации постоянные переключения на переводчик выбивают из мысли, а ручная запись слов в блокнот превращается в «кладбище информации». 
+
+Проект решает эту проблему по принципу **«автомата Калашникова»**:
+1. **Мгновенный поиск и перевод** без отвлечения от чтения.
+2. **Контекстный якорь**: сохранение слова вместе с живым предложением из документации.
+3. **Фонетическое закрепление**: нативное произношение (US/UK) и транскрипция IPA, чтобы говорить на митингах уверенно.
+4. **Интервальные повторения (SRS / SM-2)**: умная система карточек (как в Anki), напоминая слова ровно тогда, когда мозг готов их забыть.
+
+---
+
+## 📂 Документация проекта
+
+- 📋 [**План функционала и архитектура (PLAN.md)**](file:///home/kopri/notes.qpid.pro/PLAN.md) — детальный роадмап от базового MVP до умных тренажёров памяти.
+- 🎓 [**Методология и педагогика (PEDAGOGY.md)**](file:///home/kopri/notes.qpid.pro/PEDAGOGY.md) — руководство по эффективному изучению сетевого английского: почему изолированные слова не работают, сила лексических связок (chunks), алгоритм SM-2.
+
+---
+
+## 🛠 Технический стек
+
+- **Backend**: Python 3.12 (FastAPI / Uvicorn)
+- **Database**: SQLite (WAL mode, надёжность и быстрые снимки)
+- **Frontend**: Vanilla HTML5 / Modern CSS / JavaScript (PWA, мгновенная загрузка, поддержка горячих клавиш)
+- **Внешние API**: Free Dictionary API (IPA + audio), MyMemory Translation API
+- **Веб-сервер**: Nginx Reverse Proxy + SSL Let's Encrypt (`notes.qpid.pro`)
+- **Репозиторий проекта**: [Gitea (ai.qpid.pro/gitea/Antigravity/notes-qpid-pro)](https://ai.qpid.pro/gitea/Antigravity/notes-qpid-pro)
+
+---
+
+## 🚀 Быстрый старт (Разработка)
+
+```bash
+# Клонирование / переход в каталог проекта:
+cd /home/kopri/notes.qpid.pro
+
+# Создание виртуального окружения Python:
+python3 -m venv venv
+source venv/bin/activate
+
+# Запуск будет доступен после развертывания Фазы 1
+```
+
+---
+
+## 🌐 Информация о сервере и инфраструктуре
+
+- **URL сервиса**: [https://notes.qpid.pro](https://notes.qpid.pro)
+- **IP-адрес сервера**: `31.77.203.213`
+- **Каталог на сервере**: `/home/kopri/notes.qpid.pro`
+- **Git Remote**: `http://127.0.0.1:3000/Antigravity/notes-qpid-pro.git` (зеркалируется в Gitea)