docs(plan): update roadmap with security layer (auth, sessions, rate-limit) and general english scope
This commit is contained in:
Antigravity committed
1 parent
4631de5391
commit
4dbc53890a
3 files changed
+152
-159
No files matched your search
@@ -1,57 +1,44 @@
|
||||
# Notes (notes.qpid.pro)
|
||||
|
||||
> **Персональный тренажёр и словарь технического английского языка для сетевого инженера.**
|
||||
> Создан для быстрого снятия языкового барьера при чтении RFC, документации Cisco/Juniper, Linux networking и технических статей.
|
||||
> **Защищённый персональный тренажёр и словарь английского языка.**
|
||||
> Создан для быстрого и надёжного расширения словарного запаса (общий английский, фразовые глаголы, идиомы, профессиональные термины) без отвлечения от чтения и просмотра контента.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Миссия проекта
|
||||
При чтении технической документации постоянные переключения на переводчик выбивают из мысли, а ручная запись слов в блокнот превращается в «кладбище информации».
|
||||
## 🎯 Концепция и методика
|
||||
Чтение статей, книг или просмотр видео на английском часто тормозится незнакомыми словами и выражениями. Обычный переводчик даёт мгновенный ответ, но слово сразу забывается. Ручные списки превращаются в «кладбище информации».
|
||||
|
||||
Проект решает эту проблему по принципу **«автомата Калашникова»**:
|
||||
1. **Мгновенный поиск и перевод** без отвлечения от чтения.
|
||||
2. **Контекстный якорь**: сохранение слова вместе с живым предложением из документации.
|
||||
3. **Фонетическое закрепление**: нативное произношение (US/UK) и транскрипция IPA, чтобы говорить на митингах уверенно.
|
||||
4. **Интервальные повторения (SRS / SM-2)**: умная система карточек (как в Anki), напоминая слова ровно тогда, когда мозг готов их забыть.
|
||||
1. **Безопасность**: сервис работает на белом IP, защищён авторизацией (сессии, хэширование паролей, защита от брутфорса).
|
||||
2. **Мгновенный поиск и перевод**: фокус на строке ввода, каскадный перевод (словарная статья + толкование + русский перевод).
|
||||
3. **Контекстный якорь**: сохранение слова вместе с живым предложением (где встретилось выражение).
|
||||
4. **Фонетическое закрепление**: нативное аудио-произношение (US/UK) и транскрипция IPA.
|
||||
5. **Интервальные повторения (SRS / SM-2)**: встроенные карточки для перевода слов в долговременную память.
|
||||
|
||||
---
|
||||
|
||||
## 📂 Документация проекта
|
||||
|
||||
- 📋 [**План функционала и архитектура (PLAN.md)**](file:///home/kopri/notes.qpid.pro/PLAN.md) — детальный роадмап от базового MVP до умных тренажёров памяти.
|
||||
- 🎓 [**Методология и педагогика (PEDAGOGY.md)**](file:///home/kopri/notes.qpid.pro/PEDAGOGY.md) — руководство по эффективному изучению сетевого английского: почему изолированные слова не работают, сила лексических связок (chunks), алгоритм SM-2.
|
||||
- 📋 [**План функционала и архитектура (PLAN.md)**](file:///home/kopri/notes.qpid.pro/PLAN.md) — детальный план итераций: от защищённого MVP до умных интервальных тренажёров.
|
||||
- 🎓 [**Методология и педагогика (PEDAGOGY.md)**](file:///home/kopri/notes.qpid.pro/PEDAGOGY.md) — методические правила эффективного освоения языка: лексические связки (chunks), контекст, фонетика, кривая забывания Эббингауза.
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Технический стек
|
||||
|
||||
- **Backend**: Python 3.12 (FastAPI / Uvicorn)
|
||||
- **Database**: SQLite (WAL mode, надёжность и быстрые снимки)
|
||||
- **Frontend**: Vanilla HTML5 / Modern CSS / JavaScript (PWA, мгновенная загрузка, поддержка горячих клавиш)
|
||||
- **Database**: SQLite (WAL mode — надёжность, автономность, бэкап в один файл)
|
||||
- **Безопасность**: Защищённые сессии (HttpOnly cookies), PBKDF2-HMAC-SHA256, Rate Limiting
|
||||
- **Frontend**: Vanilla HTML5 / Modern CSS / ES6+ 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)
|
||||
- **IP сервера**: `31.77.203.213`
|
||||
- **Каталог проекта**: [`/home/kopri/notes.qpid.pro`](file:///home/kopri/notes.qpid.pro)
|
||||
- **Git Remote**: `http://127.0.0.1:3000/Antigravity/notes-qpid-pro.git`
|
||||
Reference in new issue
Block a user