Update README.md to enhance feature descriptions and add test user information
- Renamed "Статистика" to "Дневная статистика" and added "Сводная статистика" section with detailed metrics and visualizations. - Included a pre-configured test user for quick start and clarified registration requirements. - Updated API endpoints section to reflect the new summary statistics endpoint. - Enhanced the statistics page description with new features and metrics for user comparison.
This commit is contained in:
parent
46791c4443
commit
4d7bd1a77e
28
README.md
28
README.md
@ -11,7 +11,11 @@ Smoke Tracker - это приложение для самоконтроля и
|
|||||||
- **Регистрация и авторизация** - безопасная система входа с JWT токенами
|
- **Регистрация и авторизация** - безопасная система входа с JWT токенами
|
||||||
- **Учет сигарет** - быстрое добавление записей о выкуренных сигаретах
|
- **Учет сигарет** - быстрое добавление записей о выкуренных сигаретах
|
||||||
- **История** - просмотр последних записей с возможностью фильтрации
|
- **История** - просмотр последних записей с возможностью фильтрации
|
||||||
- **Статистика** - визуализация данных по дням с помощью графиков
|
- **Дневная статистика** - визуализация данных по дням с помощью графиков
|
||||||
|
- **Сводная статистика** - сравнение ваших показателей со средними значениями других пользователей
|
||||||
|
- График по дням недели
|
||||||
|
- Сравнение с другими пользователями
|
||||||
|
- Метрики активности
|
||||||
- **Адаптивный дизайн** - работает на всех устройствах
|
- **Адаптивный дизайн** - работает на всех устройствах
|
||||||
|
|
||||||
## 🛠 Технологии
|
## 🛠 Технологии
|
||||||
@ -123,9 +127,13 @@ smoke-tracker/
|
|||||||
|
|
||||||
### Тестовые данные для локальной разработки
|
### Тестовые данные для локальной разработки
|
||||||
|
|
||||||
Создайте пользователя через форму регистрации или используйте API напрямую.
|
Для быстрого старта доступен предустановленный тестовый пользователь:
|
||||||
|
- **Логин:** `testuser`
|
||||||
|
- **Пароль:** `test1234`
|
||||||
|
|
||||||
Минимальные требования:
|
Вы также можете создать нового пользователя через форму регистрации.
|
||||||
|
|
||||||
|
Минимальные требования для регистрации:
|
||||||
- Логин: минимум 3 символа
|
- Логин: минимум 3 символа
|
||||||
- Пароль: минимум 4 символа
|
- Пароль: минимум 4 символа
|
||||||
|
|
||||||
@ -140,6 +148,7 @@ smoke-tracker/
|
|||||||
- `POST /cigarettes/log` - Добавить запись о сигарете
|
- `POST /cigarettes/log` - Добавить запись о сигарете
|
||||||
- `GET /cigarettes` - Получить список записей
|
- `GET /cigarettes` - Получить список записей
|
||||||
- `GET /cigarettes/stats/daily` - Получить статистику по дням
|
- `GET /cigarettes/stats/daily` - Получить статистику по дням
|
||||||
|
- `GET /stats/summary` - Получить сводную статистику (индивидуальную и общую)
|
||||||
|
|
||||||
## 🎨 UI/UX
|
## 🎨 UI/UX
|
||||||
|
|
||||||
@ -163,9 +172,16 @@ smoke-tracker/
|
|||||||
- Фильтрация по датам
|
- Фильтрация по датам
|
||||||
|
|
||||||
#### Страница статистики
|
#### Страница статистики
|
||||||
- Интерактивный график (Recharts)
|
- Две вкладки: "Дневная статистика" и "Сводная статистика"
|
||||||
- Выбор периода
|
- **Дневная статистика:**
|
||||||
- Сводная статистика
|
- Интерактивный линейный график по дням (Recharts)
|
||||||
|
- Выбор периода
|
||||||
|
- Основные метрики (среднее, максимум, общее количество)
|
||||||
|
- **Сводная статистика:**
|
||||||
|
- Сравнение индивидуальных показателей с общими
|
||||||
|
- Метрики: дневное среднее (вы vs все), дней с данными, активных пользователей
|
||||||
|
- Столбчатая диаграмма по дням недели
|
||||||
|
- Таблица с детальной статистикой по дням недели
|
||||||
|
|
||||||
## 🧪 Разработка
|
## 🧪 Разработка
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user