56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# WellShe — MVP Android приложение для женщин
|
||
|
||
## Описание
|
||
WellShe — офлайн-приложение для учёта воды, домашних тренировок, дневника сна, контроля осанки и женского цикла. Все данные хранятся локально (Room + DataStore), уведомления работают без сети, экспорт/импорт — зашифрованный JSON.
|
||
|
||
## Структура
|
||
- Room: вода, тренировки, сон, осанка, цикл, настройки
|
||
- DataStore: цели, темы, уведомления, онбординг
|
||
- DI: Hilt
|
||
- UI: Jetpack Compose + Material3
|
||
- Фон: WorkManager, AlarmManager, SensorManager
|
||
- Уведомления: Notification API
|
||
- ML/аналитика: локальные алгоритмы
|
||
|
||
## Сборка и запуск
|
||
```bash
|
||
# Сборка APK
|
||
./gradlew assembleRelease
|
||
|
||
# Запуск на эмуляторе
|
||
./gradlew installDebug
|
||
|
||
# Запуск unit-тестов
|
||
./gradlew test
|
||
```
|
||
|
||
## Экспорт / импорт данных
|
||
- В настройках приложения доступны кнопки "Экспорт данных" и "Импорт данных".
|
||
- Для экспорта/импорта требуется PIN (шифрование AES-256).
|
||
|
||
## Смена темы
|
||
- В настройках приложения выберите светлую или тёмную тему.
|
||
|
||
## Сброс онбординга
|
||
- В настройках приложения доступен сброс онбординга.
|
||
|
||
## Переменные окружения
|
||
- Пример: .env.example, local.properties
|
||
|
||
## Разрешения
|
||
- POST_NOTIFICATIONS
|
||
- SCHEDULE_EXACT_ALARM
|
||
- FOREGROUND_SERVICE
|
||
|
||
## Дисклеймер
|
||
Приложение не является медицинским устройством.
|
||
|
||
## Acceptance Checklist
|
||
- Все данные офлайн (Room + DataStore)
|
||
- Уведомления без сети
|
||
- Прогноз цикла с меткой уверенности
|
||
- Сон и будильник офлайн
|
||
- Старт < 800 мс, APK < 30 МБ
|
||
- Экспорт / импорт JSON успешен
|
||
|