53 lines
2.9 KiB
Markdown
53 lines
2.9 KiB
Markdown
# Техническая документация CORP-MAUI
|
||
|
||
Добро пожаловать в техническую документацию корпоративного MAUI приложения.
|
||
|
||
## 📚 Содержание
|
||
|
||
### [Архитектура приложения](ARCHITECTURE.md)
|
||
Подробное описание архитектуры проекта, структуры кода и ключевых компонентов:
|
||
- Структура проекта
|
||
- Описание компонентов (ApiService, WebSocketService, ServiceProvider)
|
||
- Паттерны проектирования
|
||
- Используемые технологии
|
||
|
||
### [API и интеграция](API.md)
|
||
Полная документация по REST API и WebSocket протоколу:
|
||
- **REST API endpoints** - все доступные эндпоинты (employees, departments, documents, requests, posts, comments, positions, skills, calendar events, employee-actions, department-roles)
|
||
- **Пагинация** - работа с большими списками данных
|
||
- **WebSocket протокол** - real-time коммуникация
|
||
- **Аутентификация JWT** - получение и обновление токенов
|
||
- **Форматы данных** - структура запросов и ответов
|
||
- **Обработка ошибок** - статус коды и их обработка
|
||
|
||
### [Установка и настройка](SETUP.md)
|
||
Инструкции по установке, настройке и сборке проекта:
|
||
- Системные требования
|
||
- Настройка окружения разработки
|
||
- Настройка Android SDK
|
||
- Сборка и запуск на разных платформах
|
||
- Конфигурация приложения
|
||
|
||
### [Примеры кода](CODE_EXAMPLES.md)
|
||
Практические примеры использования API и компонентов:
|
||
- Аутентификация и работа с токенами
|
||
- Отправка и получение сообщений
|
||
- Работа с WebSocket
|
||
- Поиск пользователей
|
||
- Управление статусами
|
||
|
||
## 🔗 Дополнительные ресурсы
|
||
|
||
- [Главный README](../README.md) - Информация для конечных пользователей
|
||
- [ANDROID_SETUP.md](../ANDROID_SETUP.md) - Детальная настройка Android SDK
|
||
- [.NET MAUI Documentation](https://docs.microsoft.com/dotnet/maui/)
|
||
|
||
## 📝 Примечания
|
||
|
||
Эта документация предназначена для разработчиков, работающих над проектом. Если вы конечный пользователь приложения, обратитесь к [основному README](../README.md).
|
||
|
||
---
|
||
|
||
**Последнее обновление:** 2026-01-12
|
||
|