From 4d7bd1a77e91ed58bb45df90135f8e1bf9529b0d Mon Sep 17 00:00:00 2001 From: Primakov Alexandr Alexandrovich Date: Mon, 17 Nov 2025 14:36:25 +0300 Subject: [PATCH] Update README.md to enhance feature descriptions and add test user information MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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. --- README.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a051b08..4c46f7b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,11 @@ Smoke Tracker - это приложение для самоконтроля и - **Регистрация и авторизация** - безопасная система входа с JWT токенами - **Учет сигарет** - быстрое добавление записей о выкуренных сигаретах - **История** - просмотр последних записей с возможностью фильтрации -- **Статистика** - визуализация данных по дням с помощью графиков +- **Дневная статистика** - визуализация данных по дням с помощью графиков +- **Сводная статистика** - сравнение ваших показателей со средними значениями других пользователей + - График по дням недели + - Сравнение с другими пользователями + - Метрики активности - **Адаптивный дизайн** - работает на всех устройствах ## 🛠 Технологии @@ -123,9 +127,13 @@ smoke-tracker/ ### Тестовые данные для локальной разработки -Создайте пользователя через форму регистрации или используйте API напрямую. +Для быстрого старта доступен предустановленный тестовый пользователь: +- **Логин:** `testuser` +- **Пароль:** `test1234` -Минимальные требования: +Вы также можете создать нового пользователя через форму регистрации. + +Минимальные требования для регистрации: - Логин: минимум 3 символа - Пароль: минимум 4 символа @@ -140,6 +148,7 @@ smoke-tracker/ - `POST /cigarettes/log` - Добавить запись о сигарете - `GET /cigarettes` - Получить список записей - `GET /cigarettes/stats/daily` - Получить статистику по дням +- `GET /stats/summary` - Получить сводную статистику (индивидуальную и общую) ## 🎨 UI/UX @@ -163,9 +172,16 @@ smoke-tracker/ - Фильтрация по датам #### Страница статистики -- Интерактивный график (Recharts) -- Выбор периода -- Сводная статистика +- Две вкладки: "Дневная статистика" и "Сводная статистика" +- **Дневная статистика:** + - Интерактивный линейный график по дням (Recharts) + - Выбор периода + - Основные метрики (среднее, максимум, общее количество) +- **Сводная статистика:** + - Сравнение индивидуальных показателей с общими + - Метрики: дневное среднее (вы vs все), дней с данными, активных пользователей + - Столбчатая диаграмма по дням недели + - Таблица с детальной статистикой по дням недели ## 🧪 Разработка