From bc2dc81916be37d4f789e571f5e3b251fe3152ef Mon Sep 17 00:00:00 2001 From: AlexIves16 Date: Fri, 27 Mar 2026 14:38:56 +0500 Subject: [PATCH] Update README with project description --- README.md | 152 ++++++++++++++---------------------------------------- 1 file changed, 40 insertions(+), 112 deletions(-) diff --git a/README.md b/README.md index 0e7b36d..7e34fb5 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ -# NANAHUI CRM - CRM-ассистент для команд +# 🚀 NANAHUI CRM -CRM-система с AI-планированием, mind-картами задач и интеграцией с Google Calendar. +CRM-ассистент для команд с AI-планированием, mind-картами и интеграцией с Google Calendar. -## 🚀 Возможности +## 📱 Возможности -### Для команд и фрилансеров: - ✅ **Управление задачами** - создание, назначение, приоритеты, статусы -- ✅ **Mind-карты проектов** - визуальное дерево задач (drag-drop для админов) +- ✅ **Mind-карты проектов** - визуальное дерево задач - ✅ **Календарь** - синхронизация с Google Calendar - ✅ **Будильники/Напоминания** - локальные уведомления - ✅ **AI-ассистент** - умное планирование и генерация подзадач - ✅ **Ролевая модель** - admin, member, viewer - ✅ **Офлайн-режим** - кэширование данных на устройстве -## 📦 Технологический стек +## 🛠 Технологический стек | Компонент | Технология | |-----------|------------| @@ -22,135 +21,64 @@ CRM-система с AI-планированием, mind-картами зад | Backend | Firebase (Firestore, Auth, FCM) | | Local Storage | Hive | | Navigation | GoRouter | -| Mind Maps | flutter_mind_map, graphview | -| AI | OpenAI API, Anthropic API (планируется) | +| AI | OpenAI API (планируется) | -## 🏗 Структура проекта +## 🚀 Быстрый старт +### 1. Клонирование +```bash +git clone +cd NANAHUI ``` -lib/ -├── core/ -│ ├── firebase_config.dart -│ ├── local_storage_service.dart -│ ├── router.dart -│ └── theme.dart -├── features/ -│ ├── tasks/ -│ ├── mindmap/ -│ ├── calendar/ -│ └── alarms/ -├── models/ -│ ├── user_model.dart -│ ├── task_model.dart -│ ├── project_model.dart -│ ├── mind_map_model.dart -│ ├── calendar_event_model.dart -│ └── alarm_model.dart -├── providers/ -│ └── auth_provider.dart -├── screens/ -│ ├── auth_screen.dart -│ ├── home_screen.dart -│ ├── tasks_screen.dart -│ ├── mind_map_screen.dart -│ ├── calendar_screen.dart -│ └── alarms_screen.dart -└── widgets/ -``` - -## 🔧 Настройка - -### 1. Firebase Console - -1. Создайте проект в [Firebase Console](https://console.firebase.google.com) -2. Включите Authentication (Google Sign-In) -3. Создайте Firestore базу данных -4. Скачайте конфиги: - - `google-services.json` для Android - - `GoogleService-Info.plist` для iOS ### 2. Установка зависимостей - ```bash flutter pub get ``` -### 3. Запуск +### 3. Настройка Firebase +1. Создай проект в [Firebase Console](https://console.firebase.google.com) +2. Включи Authentication (Google Sign-In) +3. Создай Firestore базу данных +4. Скачай `google-services.json` и положи в `android/app/` +5. Загрузи правила безопасности из `firestore.rules` +### 4. Запуск ```bash flutter run ``` -## 📱 Роли пользователей +## 📚 Документация -| Роль | Права | -|------|-------| -| **Admin** | Создание/редактирование mind-карт, управление командой, все CRUD операции | -| **Member** | Создание задач, редактирование своих задач, просмотр общих | -| **Viewer** | Только просмотр | +- [README.md](README.md) - Общая информация +- [QUICKSTART.md](QUICKSTART.md) - Подробный быстрый старт +- [ARCHITECTURE.md](ARCHITECTURE.md) - Архитектура проекта +- [SETUP_COMPLETE.md](SETUP_COMPLETE.md) - Итоги настройки -## 🗄 Структура Firestore +## 📁 Структура проекта ``` -users/{userId} - - email, displayName, photoUrl - - role: admin|member|viewer - - teamIds: [] - - settings: {} - -teams/{teamId} - - name, description - - memberIds: [] - - projects: subcollection - -projects/{projectId} - - name, description, color - - ownerId, memberIds - - startDate, endDate - -tasks/{taskId} - - title, description - - projectId, parentTaskId - - status, priority - - assigneeId, creatorId - - dueDate, estimatedHours - - aiMetadata: {} - -mindmaps/{mindMapId} - - projectId, title - - rootNodeId - - nodes: subcollection - -events/{eventId} - - title, description - - startTime, endTime - - googleEventId - - attendeeIds: [] - -alarms/{alarmId} - - title, dateTime - - taskId, eventId - - isRepeating, repeatPattern +lib/ +├── core/ # Сервисы (Firebase, AI, Storage) +├── models/ # Модели данных +├── providers/ # State management (Riverpod) +├── screens/ # Экраны приложения +└── widgets/ # Переиспользуемые виджеты ``` -## 🤖 AI Функции (планируется) +## 🔧 Настройка окружения -- **Генерация подзадач** - разбивка больших задач на подзадачи -- **Приоритизация** - AI анализ важности задач -- **Планирование** - оптимальное распределение задач по времени -- **Саммари** - краткое описание проекта/задач -- **Анализ тональности** - анализ переписки с клиентами +1. Скопируй `.env.example` в `.env` +2. Заполни API ключами (OpenAI, Firebase, etc.) -## 📝 Следующие шаги +## 🤝 Вклад -- [ ] Настроить Firebase проект -- [ ] Добавить реальную интеграцию с Firestore -- [ ] Реализовать AI сервисы (OpenAI, Anthropic) -- [ ] Добавить Google Calendar API -- [ ] Реализовать mind-map виджет с drag-drop -- [ ] Добавить локальные уведомления -- [ ] Реализовать синхронизацию офлайн-данных +Этот проект создан для внутренней команды NANAHUI. ## 📄 Лицензия -Internal use only (для команды NANAHUI) +Internal use only + +--- + +**Создано для команды NANAHUI** 🚀