¶ Начало разработки
Необходимо клонировать репозиторий https://git.miem.hse.ru/616/miemapp. Запустить XCode и открыть корневой файл проекта
¶ Правила разработки
При начале работы над задачей необходимо отвести ветку. Когда разработка закончена нужно сделать push в репозиторий и создать merge-request.
¶ Поддерживаемые версии операционной системы
Приложение поддерживает версии iOS выше 12. Без крайней необходимости не отказываемся от старых версий.
¶ Зависимости
Зависимости в проеке подулючаются через CocoaPods.
Текущие зависимости
- GoogleOAuth
- Alamofire
¶ Архитектура проекта
Каждый модуль по сути является одним основным экраном, внутри которого может осуществляться своя навигация, независимо от главного приложения. Этому модулю также могут быть нужны доступ к постоянному хранилищу данных или сетевым запросам. Таким образом весь модуль можно свести к одной основной сущности, которая при инициализации принимает необходимые зависимости в виде аргументов, а затем предоставляет свой основной экран главному приложению. Затем на основе полученных экранов строится меню, которое позволяет открывать эти экраны. Это происходит подстановкой выбранного экрана в экран главного приложения.
Данный подход позволяет свести к минимуму количество точек интеграции модуля. Преимуществом этого является быстрая интеграция модуля, так как чтобы его экран отображался в приложении и его меню надо всего лишь создать сущность модуля и затем передать его экран в меню. Это позволяет снизить количество конфликтов при разработке сразу несколькими программистами. Также такая архитектура позволяет заменять одну реализацию модуля на другую, например, в случае смены дизайна интерфейса.
Каждый модуль может быть разработан внутри с использованием своей архитектуры. Это даёт возможность сторонним разработчикам гибкость и удобство выбора. Однако такой подход может привести к тому, что новым разработчикам будет трудно понять строение программы. Поэтому все модули имеют одинаковую архитектуру. Она основана на архитектурном шаблоне Model-View-View Model. Внутри основной сущности модуля создаются источник данных и основное представление на основе полученных зависимостей от основного приложения. Источник данных предоставляет модель для представления на основе данных с диска и из сети. Он также несёт ответственность за обновление данных в результате действий пользователя.
¶ Текущая структура проекта
¶ Авторизация
- AuthGraph – основная сущность модуля авторизации;
- AuthScreenLoad – основной экран авторизации;
- AuthServices – сущность для сетевых запросов к серверам кабинета МИЭМ и управления камерами;
- User – модель с информацией о пользователе.
¶ Расписание
- TimetableScreenLoad – основной экран модуля расписания;
- TimetableModel – модель расписания;
- TimetableItemCell – представление одной ячейки с парой;
- TimetableGraph – основная сущность модуля;
- TimetableDataSource – сущность для получения расписания из API РУЗ;
- TimetableSectionHeader – представление даты и дня недели;
- TimetableDatesHeades – представление с выбранными датами;
- DatePickerView – представление для выбора дат;
- TouchDetectingView – сущность для определения касаний и скрытия выбора дат.
¶ Личный кабинет
- CabinetLoad – основной экран модуля;
- CabinetGraph – основная сущность модуля;
- CabinetDataSource – сущность для получения данных и отправки запросов.
¶ Управление камерами
- ControlGraph – основная сущность модуля;
- CameraScreenLoad – основной экран управления камерой;
- CameraServices – сущность для сетевых запросов управления камерой;
- CrosshairView – представление поля управления позицией камеры;
- TouchGestureRecognizer – сущность для определения касаний поля;
- VideoView – представление для отображения видеопотока;
- CameraListGraph – основная сущность списка камер;
- CameraListScreenLoad – основной экран отображения списка камер;
- CameraItemCell – представление одной ячейки камеры;
- CameraListHeaders – представление заголовков с названиями аудиторий, где находятся камеры;
- CameraListDataSource – сущность для получения списка камер;
- CameraListModel – модель списка камер.
¶ Запрос записей
- RecordScreenLoad – основной экран модуля;
- RecordModel – модель данных запроса записи;
- RecordGraph – основная сущность модуля;
- RecordDataSource – сущность для получения данных о аудиториях и отправки запросов.
¶ Управление VMIX
- VMixLoad – основной экран модуля;
- VMixGraph – основная сущность модуля;
- VMixDataSource – сущность для получения данных и отправки запросов.