diff --git a/README.md b/README.md new file mode 100644 index 00000000..bcd72f5a --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# MasterPlan +[![Android Release](https://github.com/Leturgone/MasterPlan/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/Leturgone/MasterPlan/actions/workflows/release.yml) + +Клиент серверное приложения для контроля выполнения планов мероприятий. Серверная часть - [MasterPlanApi](https://github.com/Leturgone/MasterPlanApi) + +## Оглавление + +- [Описание](#описание) +- [Технологический стек](#технологический-стек) +- [Установка](#установка) +- [Функционал](#функционал) + + +## Описание + +[](app/src/main/res/icon/ic_launcher-playstore.png) + +MasterPlan это мобильное приложение для Android написанное на языке Kotlin, позволяющее упростить контроль выполнения планов мероприятий в подразделении предприятия.
+





+ +## Технологический стек + + + +- **Android** – ОС, на которой разработано приложение +- **Android SDK 36** – Средство разработки приложения +- **Kotlin** – Основной язык, на котором разработано прилжение +- **Jetpack Compose** - набор инструментов для построения UI +- **Clean Architecture** - разделение по слоям domain, data, framework (андроид компоненты) +- **MVVM** - Архитектурный паттерн +- **Retrofit** - для обращения к [MasterPlanApi](https://github.com/Leturgone/MasterPlanApi) +- **Dagger Hilt** - для внедрения зависимостей (DI) +- **Datastore** - для хранения токена автризации и состояния темы +- **Coroutines + Flow** +- **Android Services** - для создания уведомлений был создан WebsocketNotificationService наследуемый от Service +- **CI/CD** - создание релиза автоматически через github actions + +





+ +## Установка +1. Скачать apk из последнего релиза; +2. Установить на устройство. + +## Функционал + +Для приложения реализован ролевой доступ. Для представления функций предоставлен Use Case + +изображение + + + diff --git a/app/src/main/ic_launcher-playstore.png b/app/src/main/res/icon/ic_launcher-playstore.png similarity index 100% rename from app/src/main/ic_launcher-playstore.png rename to app/src/main/res/icon/ic_launcher-playstore.png diff --git a/demo.gif b/demo.gif new file mode 100644 index 00000000..4bddc7e0 Binary files /dev/null and b/demo.gif differ