MpeiX - приложение МЭИ здорового человека

Расписание пар, заметки, личный кабинет БАРС и крутая карта для студентов и преподавателей НИУ МЭИ. Самое функциональное, легковесное и стабильное МЭИшное приложение.

Фичи приложения:

• Просмотр расписаний групп и преподавателей
• Карта корпусов, общежитий, мест общепита, известных мест кампуса МЭИ и кафедр.
• Добавление заметок к парам.
• Просмотр ЛК БАРС.
• Дашборд с ближайшими парами, заметками, расписанием сессии и объявлениями.
• Быстрое переключение между избранными расписаниями.
• Переключение между ТЁМНОЙ ТЕМОЙ и светлой темой.
• Переключение между русским и английским языком в приложении.
• Поиск по заметкам, карте, группам и преподавателям.
• Предпросмотр расписаний групп и преподавателей прямо с экрана поиска.
• Кэширование расписаний и геометок на устройстве.
• Поддержка версии для планшетов.
• Самый маленький вес приложения по сравнению с конкурентами.
• Открiтый исходнiй код.
• Меми.🤗💪😸😃

Пулл реквесты приветствуются.

Скриншоты

Требования приложения

• Android 5.0 Lollipop и выше (Api V21+)
• Доступ к интернету

Стек

• Многомодульная, упрощенная Clean Architecture с активным использованием DI Koin.
• Vivid Money Elmslie
• Самописная навигация
• Retrofit + RxJava для REST Api
• Vanilla SQLite для хранения в БД заметок и избранных расписаний
• Firebase
  • Crashlytics
  • Analytics
  • Remote Config
• Для подгрузки изображений используется Picasso (из-за соотношения веса и скорости работы)
• Для тестирования используется JUnit 5 + Kotest

Архитектура

Для слоя представления используется паттерн ELM на базе Vivid Money Elmslie. Подробнее про устройство читайте в репозитории по ссылке. Разделение на common, domain, feature модули.

• common - могут зависеть от других common-модулей
• domain - могут зависеть от других common-модулей и domain-модулей
• feature - могут зависеть от common-модулей и domain-модулей, но ни в коем случае не зависят от feature-модулей.

Сделано это для ускорения билда и уменьшения связности кода. Также повсюду выпилен kapt. Везде, где можно, используются обычные kotlin-модули вместо android-модулей. В android-модулях подключено минимум зависимостей, минимум плагинов. Используются обыкновенные groovy gradle скрипты вместо buildSrc и KTS.

Планы на будущее

1. В самое ближайшее время планируется переход с RxJava на Kotlin Coroutines, как более легковесную альтернативу. Ну и потому что корутины теперь являются новым мейнстримом.
2. Переход с Fragments на Jetpack Compose. Это позволит уменьшить вес приложения, увеличить скорость билда, да и в целом упростить поддержку кодовой базы, что положительно скажется на частоте обновлений приложения.
3. Редизайн приложения в соответствии с новыми гайдлайнами Material.
4. Полировка существующих фич и добавление нового функционала. Новые фичи сейчас на стадии рисовки в Figma. Добавляться будут только реально необходимые функции. Лишная фигня, которой пользуются раз в год и которую сложно поддерживать, в приложении появляться не будет.

Инструкция по сборке проекта

1. Добавьте google-services.json от Firebase в корень модуля app и в app/src/debug (можно один и тот же). Инструкция по получению google-services.json.

2. В глобальный gradle.properties добавьте поле mpeiapp_google_maps_api_key="{SECRET}", где {SECRET} - ключ от API Google Maps. Инструкция по получению ключа.

3. Скачайте и установите JDK 17 версии, укажите в настройках проекта java 17 по умолчанию для Gradle и компилятора Kotlin:

   File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle

4. Установите плагин Kotest, с ним будет проще гонять тесты.

После первых двух пунктов проект соберется, после двух других начнут работать тесты. В связи с выходом Gradle 7.5.0 и AGP 7.4.0 проект перешел на Java 17.

По понятным причинам в репозитории не будут опубликованы оригинальные ключи от Google Maps API и Firebase API. Используйте свои ключики.