|
|
@@ -1 +1,201 @@
|
|
|
-
|
|
|
+# LinguaMaster — приложение для изучения иностранных языков
|
|
|
+
|
|
|
+> [!NOTE]
|
|
|
+> **LinguaMaster** — мобильное Android-приложение для изучения английского и французского языков.
|
|
|
+>
|
|
|
+> > «Изучение языка — это не заучивание слов, а открытие нового способа понимать мир.»
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Аннотация
|
|
|
+
|
|
|
+LinguaMaster представляет собой мобильное приложение для операционной системы Android, предназначенное для интерактивного изучения иностранных языков. Приложение поддерживает обучение английскому и французскому языкам, предоставляет систему упражнений, многоязычный глоссарий, систему прогресса и достижений, а также синхронизацию данных через PostgreSQL.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Введение
|
|
|
+
|
|
|
+## Основные возможности приложения
|
|
|
+
|
|
|
+- 📚 Многоязычный глоссарий (RU ↔ EN ↔ FR)
|
|
|
+- 🎧 Фонетические упражнения с аудио
|
|
|
+- ✍️ Грамматические задания
|
|
|
+- 🏆 Система достижений и XP
|
|
|
+- 🌙 Поддержка тёмной темы
|
|
|
+- ☁️ Синхронизация данных с сервером
|
|
|
+- 🔒 Безопасная авторизация пользователей
|
|
|
+- 📱 Поддержка Android 8.0+
|
|
|
+
|
|
|
+## Основные модули системы
|
|
|
+
|
|
|
+1. Авторизация и регистрация
|
|
|
+2. Dashboard с отображением прогресса
|
|
|
+3. Раздел упражнений
|
|
|
+4. Глоссарий
|
|
|
+5. Профиль пользователя
|
|
|
+6. Административная панель
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Назначение и условия применения
|
|
|
+
|
|
|
+Программный продукт предназначен для:
|
|
|
+
|
|
|
+- самостоятельного изучения иностранных языков;
|
|
|
+- поддержки учебного процесса;
|
|
|
+- дистанционного взаимодействия через PostgreSQL;
|
|
|
+- хранения и обработки пользовательского прогресса;
|
|
|
+- работы в офлайн-режиме с последующей синхронизацией.
|
|
|
+
|
|
|
+## Минимальные системные требования
|
|
|
+
|
|
|
+| Компонент | Требование |
|
|
|
+|---|---|
|
|
|
+| ОС | Android 8.0+ |
|
|
|
+| RAM | от 2 ГБ |
|
|
|
+| Интернет | Wi-Fi / 4G / 5G |
|
|
|
+| Свободная память | ≥ 50 МБ |
|
|
|
+| Экран | 5.0″ – 7.0″ |
|
|
|
+
|
|
|
+## Условия эксплуатации
|
|
|
+
|
|
|
+- наличие интернет-соединения;
|
|
|
+- поддержка HTTPS/TLS 1.2+;
|
|
|
+- установленный APK-файл приложения;
|
|
|
+- разрешение доступа к сети;
|
|
|
+- наличие PostgreSQL-сервера для синхронизации данных.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Установка
|
|
|
+
|
|
|
+## Порядок установки приложения
|
|
|
+
|
|
|
+1. Скачать APK-файл приложения из репозитория.
|
|
|
+2. Проверить контрольную сумму SHA-256.
|
|
|
+3. Разрешить установку из неизвестных источников.
|
|
|
+4. Запустить установщик.
|
|
|
+5. Предоставить необходимые разрешения.
|
|
|
+6. Выполнить первый запуск приложения.
|
|
|
+
|
|
|
+## Чекбокс выполнения установки
|
|
|
+
|
|
|
+- [x] Загрузка APK-файла
|
|
|
+- [x] Проверка контрольной суммы
|
|
|
+- [x] Установка приложения
|
|
|
+- [x] Выдача разрешений
|
|
|
+- [x] Проверка запуска
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Описание операций
|
|
|
+
|
|
|
+## Авторизация пользователя
|
|
|
+
|
|
|
+Пользователь вводит email и пароль, после чего система выполняет проверку данных и открывает главный экран приложения.
|
|
|
+
|
|
|
+### Пример SQL-запроса авторизации
|
|
|
+
|
|
|
+```sql
|
|
|
+SELECT *
|
|
|
+FROM users
|
|
|
+WHERE email = ?
|
|
|
+AND password_hash = ?;
|
|
|
+
|
|
|
+## Работа с упражнениями
|
|
|
+
|
|
|
+1. Пользователь выбирает тип упражнения.
|
|
|
+2. Система загружает задания.
|
|
|
+3. Выполняется проверка ответа.
|
|
|
+4. Начисляется XP.
|
|
|
+5. Отображается результат.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Работа с глоссарием
|
|
|
+
|
|
|
+Пользователь может:
|
|
|
+
|
|
|
+- искать слова;
|
|
|
+- фильтровать словарь;
|
|
|
+- прослушивать аудио;
|
|
|
+- добавлять слова в избранное.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Демонстрация интерфейса
|
|
|
+
|
|
|
+## Экран авторизации
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Главное меню
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Раздел упражнений
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Глоссарий
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Термины и сокращения
|
|
|
+
|
|
|
+| Термин | Полная форма | Описание |
|
|
|
+|---|---|---|
|
|
|
+| XP | Experience Points | Очки опыта пользователя |
|
|
|
+| CRUD | Create Read Update Delete | Операции управления данными |
|
|
|
+| MVVM | Model View ViewModel | Архитектурный паттерн |
|
|
|
+| API | Application Programming Interface | Интерфейс взаимодействия |
|
|
|
+| JSONB | Binary JSON | Формат хранения данных |
|
|
|
+| UI/UX | User Interface / User Experience | Интерфейс и пользовательский опыт |
|
|
|
+| HTTPS | HyperText Transfer Protocol Secure | Защищённый сетевой протокол |
|
|
|
+| SQLite | SQLite Database | Локальная база данных |
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Справочная информация
|
|
|
+
|
|
|
+<p align="left">
|
|
|
+<b>Серверная часть</b><br>
|
|
|
+PostgreSQL 13+
|
|
|
+</p>
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+<p align="center">
|
|
|
+<b>Архитектура приложения</b><br>
|
|
|
+MVVM + Repository + LiveData
|
|
|
+</p>
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+<p align="right">
|
|
|
+<b>Версия приложения</b><br>
|
|
|
+v1.0.0
|
|
|
+</p>
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Контакты
|
|
|
+
|
|
|
+Telegram:
|
|
|
+[https://t.me/your_telegram](https://t.me/your_telegram)
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Дополнительная информация
|
|
|
+
|
|
|
+> **Важно:** приложение поддерживает офлайн-режим с последующей автоматической синхронизацией данных после восстановления соединения.
|
|
|
+
|
|
|
+***LinguaMaster обеспечивает безопасное и интерактивное обучение иностранным языкам на мобильных устройствах Android.***
|
