docs(project): update detailed project overview and widget documentation

EndyKaufman · EndyKaufman · commit e601525a877b · 2026-01-05T11:56:04.000+05:00
- Add comprehensive descriptions for web, mobile, and backend components
- Specify database models and tRPC API endpoints
- Include dynamic mobile APK download feature from GitHub releases
- Clarify widget implementations: habits, clock, calendar, and counter widgets
- Correct backend technology references to AnalogJS server routes
- Update README files to reflect new features and component details
- Enhance technical documentation with release service and unique constraints
- Expand task list with finalized functionalities and milestones completed
diff --git a/PROJECT_OVERVIEW.md b/PROJECT_OVERVIEW.md
@@ -7,6 +7,43 @@ Creating a dashboard management system for displaying information on old Android
 
 ### Main Components
 
+#### 1. Web Application (AnalogJS + tRPC + Pico.css)
+- User registration and anonymous mode with identifier storage in localStorage
+- Creation, editing, and deletion of dashboards
+- Addition, configuration, and deletion of widgets (clocks, calendar, habits tracking)
+- QR code generation for phone binding
+- Reattachment of anonymous users during subsequent registration
+- UX and SEO: "Continue as Guest" button, meta tags for dashboards
+
+#### 2. Mobile Application (Ionic + Capacitor)
+- QR code scanning to bind phone to dashboard
+- Retrieving widget list from server via tRPC API
+- Displaying widgets: clock with timezone and name, calendar with fixed month and date, habits tracking with interactive interface
+- Automatic widget updates
+- Offline widget caching support
+- Minimal interface: display only, no editing
+
+#### 3. Backend (AnalogJS server routes + tRPC + Prisma + PostgreSQL)
+**Database Models (schema from schema.prisma):**
+- **User**: id, anonymousId, telegramUserId, supabaseUserId, isBlackTheme, Session[], Dashboard[]
+- **Session**: id, userId, createdAt, deletedAt
+- **Dashboard**: id, name, deviceId, userId, isBlackTheme, Widget[], createdAt, updatedAt, deletedAt
+- **Widget**: id, options (JSON), state (JSON), grid (columnIndex, rowIndex, columnCount, rowCount), colors, dashboardId, createdAt, updatedAt, deletedAt
+- **WidgetLog**: id, oldOptions, newOptions, oldState, newState, widgetId, createdAt, updatedAt, deletedAt
+
+**tRPC Endpoints:**
+- `/user/register` – user registration
+- `/user/login` – login
+- `/dashboards/create` / `/dashboards/update` / `/dashboards/delete` / `/dashboards/get`
+- `/widgets/create` / `/widgets/update` / `/widgets/delete` / `/widgets/get`
+- `/devices/link` – phone binding via QR code
+- `/devices/widgets` – getting widgets for phone
+- `/releases/getMobileApkUrl` – getting mobile APK download URL from GitHub releases
+- Logging widget changes in WidgetLog
+- Anonymous users: localStorage stores identifier, reattachment during registration
+
+### Main Components
+
 #### 1. Web Application (AnalogJS + tRPC + Pico.css)
 - User registration and anonymous mode with identifier storage in localStorage
 - Creation, editing, and deletion of dashboards
@@ -23,7 +60,7 @@ Creating a dashboard management system for displaying information on old Android
 - Offline widget caching support
 - Minimal interface: display only, no editing
 
-#### 3. Backend (NestJS + Prisma + PostgreSQL)
+#### 3. Backend (AnalogJS server routes + tRPC + Prisma + PostgreSQL)
 **Database Models (schema from schema.prisma):**
 - **User**: id, anonymousId, telegramUserId, isBlackTheme, Session[], Dashboard[]
 - **Session**: id, userId, createdAt, deletedAt
@@ -86,7 +123,7 @@ Creating a dashboard management system for displaying information on old Android
 |
 | tRPC API
 v
-[Backend NestJS + Prisma + PostgreSQL]
+[Backend AnalogJS server routes + Prisma + PostgreSQL]
 |
 | tRPC API
 v
@@ -139,6 +176,7 @@ v
    - ✅ Email/password registration
       - ✅ Supabase authentication with email/password and OAuth providers
       - ✅ Supabase user fields in database with proper data synchronization
+      - ✅ Dynamic mobile APK download feature from GitHub releases
 
 2. **Dashboard Management**
    - ✅ Full CRUD operations for dashboards
diff --git a/PROJECT_OVERVIEW_RU.md b/PROJECT_OVERVIEW_RU.md
@@ -7,6 +7,43 @@
 
 ### Основные компоненты
 
+#### 1. Веб-приложение (AnalogJS + tRPC + Pico.css)
+- Регистрация пользователя и анонимный режим с сохранением идентификатора в localStorage
+- Создание, редактирование и удаление дашбордов
+- Добавление, настройка и удаление виджетов (часы, календарь, отслеживание привычек)
+- Генерация QR-кода для привязки телефона
+- Перепривязка анонимных пользователей при последующей регистрации
+- UX и SEO: кнопка «Продолжить как гость», мета-теги для дашбордов
+
+#### 2. Мобильное приложение (Ionic + Capacitor)
+- Сканирование QR-кода для привязки телефона к дашборду
+- Получение списка виджетов с сервера через tRPC API
+- Отображение виджетов: часы с таймзоной и названием, календарь с фиксированным месяцем и датой, отслеживание привычек с интерактивным интерфейсом
+- Автоматическое обновление виджетов
+- Поддержка офлайн-кэша виджетов
+- Минимальный интерфейс: только отображение, без редактирования
+
+#### 3. Бэкенд (AnalogJS серверные маршруты + tRPC + Prisma + PostgreSQL)
+**Модели базы данных (схема из schema.prisma):**
+- **User**: id, anonymousId, telegramUserId, supabaseUserId, isBlackTheme, Session[], Dashboard[]
+- **Session**: id, userId, createdAt, deletedAt
+- **Dashboard**: id, name, deviceId, userId, isBlackTheme, Widget[], createdAt, updatedAt, deletedAt
+- **Widget**: id, options (JSON), state (JSON), grid (columnIndex, rowIndex, columnCount, rowCount), colors, dashboardId, createdAt, updatedAt, deletedAt
+- **WidgetLog**: id, oldOptions, newOptions, oldState, newState, widgetId, createdAt, updatedAt, deletedAt
+
+**Эндпоинты tRPC:**
+- `/user/register` – регистрация пользователя
+- `/user/login` – вход
+- `/dashboards/create` / `/dashboards/update` / `/dashboards/delete` / `/dashboards/get`
+- `/widgets/create` / `/widgets/update` / `/widgets/delete` / `/widgets/get`
+- `/devices/link` – привязка телефона через QR-код
+- `/devices/widgets` – получение виджетов для телефона
+- `/releases/getMobileApkUrl` – получение URL загрузки мобильного APK из релизов GitHub
+- Логирование изменений виджетов в WidgetLog
+- Анонимные пользователи: localStorage хранит идентификатор, перепривязка при регистрации
+
+### Основные компоненты
+
 #### 1. Веб-приложение (AnalogJS + tRPC + Pico.css)
 - Регистрация пользователя и анонимный режим с сохранением идентификатора в localStorage
 - Создание, редактирование и удаление дашбордов
@@ -23,7 +60,7 @@
 - Поддержка офлайн-кэша виджетов
 - Минимальный интерфейс: только отображение, без редактирования
 
-#### 3. Бэкенд (NestJS + Prisma + PostgreSQL)
+#### 3. Бэкенд (AnalogJS серверные маршруты + tRPC + Prisma + PostgreSQL)
 **Модели базы данных (схема из schema.prisma):**
 - **User**: id, anonymousId, telegramUserId, isBlackTheme, Session[], Dashboard[]
 - **Session**: id, userId, createdAt, deletedAt
@@ -86,7 +123,7 @@
 |
 | tRPC API
 v
-[Бэкенд NestJS + Prisma + PostgreSQL]
+[Бэкенд AnalogJS серверные маршруты + Prisma + PostgreSQL]
 |
 | tRPC API
 v
@@ -139,6 +176,7 @@ v
    - ✅ Регистрация по email/password
    - ✅ Аутентификация через Supabase с email/password и OAuth провайдерами
    - ✅ Поля пользователей Supabase в базе данных с правильной синхронизацией данных
+   - ✅ Функция динамического получения и загрузки APK мобильного приложения из GitHub релизов
 
 2. **Управление дашбордами**
    - ✅ Полные операции CRUD для дашбордов
diff --git a/README.md b/README.md
@@ -4,23 +4,6 @@ This is a comprehensive dashboard management system for displaying information o
 
 ## Features
 
-- Web application for creating and managing dashboards
-- Mobile application for displaying widgets on Android phones
-- QR code based device binding
-- Real-time widget updates
-- Support for multiple widget types (clock, calendar, habits tracking, counter)
-- Anonymous user mode
-- Telegram authentication
-- Supabase authentication with email/password and OAuth providers
-- Dark/light theme support
-- Widget grid positioning and customization
-- Mobile offline widget caching
-- Dashboard sharing and templates
-- API rate limiting and security features
-- User analytics and reporting
-- Multi-language support
-- Widget marketplace and automation features
-
 - Web application for creating and managing dashboards
 - Mobile application for displaying widgets on Android phones
 - QR code based device binding
@@ -29,6 +12,7 @@ This is a comprehensive dashboard management system for displaying information o
 - Anonymous user mode
 - Telegram authentication
 - Supabase authentication with email/password and OAuth providers
+- Dynamic mobile APK download from GitHub releases
 - Dark/light theme support
 - Widget grid positioning and customization
 - Mobile offline widget caching
diff --git a/README_RU.md b/README_RU.md
@@ -4,23 +4,6 @@
 
 ## Особенности
 
-- Веб-приложение для создания и управления дашбордами
-- Мобильное приложение для отображения виджетов на Android-устройствах
-- Привязка устройств через QR-код
-- Обновление виджетов в реальном времени
-- Поддержка нескольких типов виджетов (часы, календарь, отслеживание привычек, счетчик)
-- Анонимный режим пользователя
-- Аутентификация через Telegram
-- Аутентификация через Supabase с email/password и OAuth провайдерами
-- Поддержка темной/светлой темы
-- Позиционирование виджетов в сетке и настройка
-- Кэширование виджетов в автономном режиме на мобильном устройстве
-- Совместное использование дашбордов и шаблоны
-- Ограничение частоты запросов к API и функции безопасности
-- Аналитика пользователей и отчеты
-- Поддержка нескольких языков
-- Маркетплейс виджетов и функции автоматизации
-
 - Веб-приложение для создания и управления дашбордами
 - Мобильное приложение для отображения виджетов на Android-устройствах
 - Привязка устройств через QR-код
@@ -29,6 +12,7 @@
 - Анонимный режим пользователя
 - Аутентификация через Telegram
 - Аутентификация через Supabase с email/password и OAuth провайдерами
+- Динамическая загрузка мобильного APK из релизов GitHub
 - Поддержка темной/светлой темы
 - Позиционирование виджетов в сетке и настройка
 - Кэширование виджетов в автономном режиме на мобильном устройстве
diff --git a/web/TECHNICAL_DOCUMENTATION.md b/web/TECHNICAL_DOCUMENTATION.md
@@ -88,13 +88,16 @@ model User {
   anonymousId      String?
   telegramUserId   String?
   telegramUserData Json?
+  supabaseUserId   String?
+  supabaseUserData Json?
   isBlackTheme     Boolean?
   createdAt        DateTime    @default(now())
   updatedAt        DateTime    @default(now())
   Session          Session[]
   Dashboard        Dashboard[]
 
-  @@unique([telegramUserId], map: "UQ_USER")
+  @@unique([telegramUserId], map: "UQ_USER_TELEGRAM")
+  @@unique([supabaseUserId], map: "UQ_USER_SUPABASE")
 }
 ```
 
@@ -204,9 +207,14 @@ model WidgetLog {
 ### Widget Routes
 - Widget management operations (partially implemented)
 
+### Releases Routes
+- `/releases/getMobileApkUrl` - Get mobile APK download URL from GitHub releases
+
 ## Widgets Implementation
 
-The project includes multiple widget implementations: Habits Tracking Widget, Clock Widget, Calendar Widget, and Counter Widget. Detailed documentation for widgets is available in the [Widgets Documentation](WIDGETS_DOCUMENTATION.md) and [Widgets Documentation (Russian)](WIDGETS_DOCUMENTATION_RU.md) files.
+The project includes multiple widget implementations: Habits Tracking Widget, Clock Widget, and Calendar Widget. Detailed documentation for widgets is available in the [Widgets Documentation](WIDGETS_DOCUMENTATION.md) and [Widgets Documentation (Russian)](WIDGETS_DOCUMENTATION_RU.md) files.
+
+The project also includes a release service that fetches mobile APK download URLs from GitHub releases. The service queries the GitHub API to find releases with names starting with 'mobile@' and retrieves the download URL for 'app-release-signed.apk' assets.
 
 ## Mobile Application Structure
 
@@ -361,13 +369,19 @@ If you encounter this error with a different domain, you can add it to the `allo
 8. Implement widget state management and logging
 9. Add offline caching for mobile widgets
 10. Implement user metrics and logging
-11. Prepare for MVP release
-5. Implement auto-refresh polling for real-time updates
-6. Add color theme support for widgets
-7. Implement widget state management and logging
-8. Add offline caching for mobile widgets
-9. Implement user metrics and logging
-10. Prepare for MVP release
+11. Implement auto-refresh polling for real-time updates
+12. Add color theme support for widgets
+13. Implement widget state management and logging
+14. Add offline caching for mobile widgets
+15. Implement user metrics and logging
+16. Prepare for MVP release
+17. Implement dynamic mobile APK download from GitHub releases
+18. Complete widget CRUD operations (COMPLETED)
+19. Complete mobile QR code scanning and device linking (COMPLETED)
+20. Complete widget components for mobile display (COMPLETED)
+21. Complete offline caching for mobile widgets (COMPLETED)
+22. Complete push notifications for mobile (COMPLETED)
+23. Complete analytics and metrics collection (COMPLETED)
 
 ## Community
 
diff --git a/web/WIDGETS_DOCUMENTATION.md b/web/WIDGETS_DOCUMENTATION.md
@@ -2,7 +2,7 @@
 
 ## Overview
 
-This document describes the implementation of widgets in the "My Dashboard" project. Currently, one widget has been implemented - the Habits Tracking Widget, which allows users to track their daily habits and activities.
+This document describes the implementation of widgets in the "My Dashboard" project. Currently, multiple widgets have been implemented including the Habits Tracking Widget, Clock Widget, Calendar Widget, and Counter Widget, which allow users to track their daily habits, view time and date, and maintain counters with history tracking.
 
 ## Implemented Widgets
 
diff --git a/web/WIDGETS_DOCUMENTATION_RU.md b/web/WIDGETS_DOCUMENTATION_RU.md
@@ -2,10 +2,12 @@
 
 ## Обзор
 
-В этом документе описана реализация виджетов в проекте "Мой Дашборд". В настоящее время реализован один виджет - виджет отслеживания привычек (Habits Widget), который позволяет пользователям отслеживать свои ежедневные привычки и активности.
+В этом документе описана реализация виджетов в проекте "Мой Дашборд". В настоящее время реализовано несколько виджетов, включая виджет отслеживания привычек (Habits Widget), виджет часов (Clock Widget), виджет календаря (Calendar Widget) и виджет счётчика (Counter Widget), которые позволяют пользователям отслеживать свои ежедневные привычки, просматривать время и дату, а также вести счётчики с историей изменений.
 
 ## Реализованные виджеты
 
+
+
 ### Виджет отслеживания привычек (Habits Widget)
 
 Виджет отслеживания привычек позволяет пользователям отслеживать свои ежедневные привычки и активности с помощью интерактивного интерфейса.
