Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/AlbatovK/Dira
Browse files Browse the repository at this point in the history
  • Loading branch information
@AlbatovK
AlbatovK committed Dec 2, 2022
2 parents a9a88f9 + aedef42 commit e08bede
Showing 1 changed file with 51 additions and 36 deletions.
87 changes: 51 additions & 36 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# Dira

[![CodeFactor](https://www.codefactor.io/repository/github/albatovk/dira/badge)](https://www.codefactor.io/repository/github/albatovk/dira) [![codebeat badge](https://codebeat.co/badges/62a80729-e763-4c24-b243-59d9138c0f75)](https://codebeat.co/projects/github-com-albatovk-dira-master)
[![CI Build and Test](https://github.com/AlbatovK/Dira/actions/workflows/main.yml/badge.svg)](https://github.com/AlbatovK/Dira/actions/workflows/main.yml)
# Что из себя представляет Dira?

<img src="https://github.com/AlbatovK/Dira/blob/master/app/src/main/res/drawable-v24/logo.png" height="200" align="right" vspace="50" hspace="50">


Android-приложение Directa (сокр. Dira) - это планер, который
способен улучшить жизнь пользователей. Он позволяет структурировать их ежедневные задачи и поддерживать уровень их мотивации за счёт соревновательного духа. Именно наличие соревновательной системы выделяет наш проект на фоне других.
# Как же это выглядит?
Каждый день пользователь может выбрать в свой список ежедневных дел определённые таски из списка предложенных. Затем, когда он выполняет одно из своих заданий, он отмечает его выполненным, после чего ему начисляются очки.
Приложение позволяет как составить свой собственный план на день, так и импортировать его у ваших друзей, которых вы можете добавить в приложении.
способен улучшить жизнь пользователей. Он позволяет структурировать их ежедневные задачи и поддерживать уровень их мотивации за счёт соревновательного духа.
Именно наличие соревновательной системы выделяет наш проект на фоне других.

Как же это выглядит?

Каждый день пользователь может выбрать в свой список ежедневных дел определённые таски из списка предложенных. Затем, \
когда он выполняет одно из своих заданий, он отмечает его выполненным, после чего ему начисляются очки.


Приложение позволяет как составить свой собственный план на день, \
так и импортировать его у ваших друзей, которых вы можете добавить в приложении.
# Для чего нужны очки?
Очки пользователя позволяют ему участвовать в системе рейтингов и лиг, которые позволяют соревноваться с другими пользователями, улучшать свои результаты и повышать заинтересованность в достижении целей.
# Что в итоге?
Expand All @@ -15,37 +26,36 @@ Android-приложение Directa (сокр. Dira) - это планер, к
# Техническая характеристика проекта
Проект состоит из Android-приложения, серверной части [(ссылка на репозиторий)](https://github.com/AlbatovK/DiraServer) и сторонних сервисов, добавляющих функционал в приложение.
* Стэк технологий
* Kotlin Coroutines - выполнение асинхронных операций для работы с сетью
* Retrofit - быстрый и удобный доступ к API со стороны клиента
* Spring Boot Framework - web-приложение развёрнутое на хостинге [(ссылка на сервер)](https://secret-escarpment-88160.herokuapp.com) Heroku
* Swagger2 - автоматическое создание документации API [(ссылка на документацию)](https://secret-escarpment-88160.herokuapp.com/swagger-ui.html)
* Google Firebase Firestore - серверная документоориентированная NoSql база данных
* Firebase Auth - аутенфикация пользователей
* SharedPreferences - хранение временных данных пользователя на устройстве
* Android Jetpack
* Fragment - использование нескольких экранов в рамках одной активности
* Navigation - навигация между фрагментами в рамках одной активности и создание вложенных контейнеров навигации
* Navigation SafeArgs Plugin - безопасная передача данных между фрагментами
* Lifecycle - обработка событий на основе жизненного цикла приложения
* ViewModel - хранение и использование данных относящихся к UI в привязке к жизненному циклу представления
* RecyclerView - представление данных в виде интерактивного списка
* ViewBinding - современный способ доступа к элементам разметки
* `Kotlin Coroutines` и `Kotlin FLow` - выполнение асинхронных операций для работы с сетью
* `Retrofit` - быстрый и удобный доступ к API со стороны клиента
* `Spring Boot Framework` - web-приложение развёрнутое на хостинге [(ссылка на сервер)](https://diraserver.herokuapp.com) Heroku
* `Swagger2` - автоматическое создание документации API [(ссылка на документацию)](https://diraserver.herokuapp.com/swagger-ui.html)
* `Google Firebase Firestore` - серверная документоориентированная NoSql база данных
* `Firebase Auth` - аутенфикация пользователей
* `SharedPreferences` - хранение временных данных пользователя на устройстве
* `Android Jetpack`
* `Fragment` - использование нескольких экранов в рамках одной активности
* `NavigationUI` - навигация между фрагментами в рамках одной активности и создание вложенных контейнеров навигации
* `Navigation SafeArgs Plugin` - безопасная передача данных между фрагментами
* `Lifecycle` - обработка событий на основе жизненного цикла приложения
* `ViewModel` - хранение и использование данных относящихся к UI в привязке к жизненному циклу представления
* `RecyclerView` - представление данных в виде интерактивного списка
* `ViewBinding` - современный способ доступа к элементам разметки
* Современная архитектура
* Многоуровневая архитектура
* Паттерн проектирования MVVM на стороне клиента
* Clean Architecture и UseCases
* Spring MVС на стороне сервера
* Koin - Инъекция зависимостей
* JUnit4 и Espresso - тестирование
* Паттерн проектирования `MVVM` на стороне клиента
* `Clean Architecture` и `UseCases`
* `Spring MVС` на стороне сервера
* `Koin` - Инъекция зависимостей
* `JUnit4` и `Espresso` - тестирование
* Continious Integration
* GitHub Actions - сборка и анализ артефакта приложения с помощью Gradle
* Detekt - статический анализатор кода
* Автоматический анализ кода с помощью сторонних сервисов (Codebeat, Codefactor)
* Firebase Analytics и Firebase Crashlytics - отслеживание состояния приложения и сбор статистики в реальном времени
* `GitHub Actions` - сборка и анализ артефакта приложения с помощью Gradle
* `Detekt` - статический анализатор кода
* Автоматический анализ кода с помощью сторонних сервисов (`Codebeat`, `Codefactor`)
* `Firebase Analytics` и `Firebase Crashlytics` - отслеживание состояния приложения и сбор статистики в реальном времени
* UI
* Material design
* MaterialUI - Элементы навигации Bottom Navigation и Navigation Drawer из NavigationUI
* TapTargetView library - интерактивные подсказки
* `Material design`
* `MaterialUI` - Элементы навигации `Bottom Navigation` и `Navigation Drawer` из NavigationUI

# Базовая структура
![](https://github.com/AlbatovK/KQuiz/blob/master/assets/circles.drawio.svg?raw=true)
Expand All @@ -56,13 +66,18 @@ Android-приложение Directa (сокр. Dira) - это планер, к
# Структура интерфейса
![](https://github.com/AlbatovK/Dira/blob/master/assets/dirascheme.drawio.svg?raw=true)

# Скриншоты работы приложения
# Скриншоты работы приложения (Версия 1.0.0)
![](https://github.com/AlbatovK/Dira/blob/master/assets/enter.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/register.jpg?raw=true) |
| -------------- | -------------- |
| ![](https://github.com/AlbatovK/Dira/blob/master/assets/welcome.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/main.jpg?raw=true) |
| ![](https://github.com/AlbatovK/Dira/blob/master/assets/note_list.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/note_choose.jpg?raw=true) |
![](https://github.com/AlbatovK/Dira/blob/master/assets/user_list.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/search.jpg?raw=true)
![](https://github.com/AlbatovK/Dira/blob/master/assets/other_profile.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/league.jpg?raw=true)
| ![](https://github.com/AlbatovK/Dira/blob/master/assets/drawer.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/note_list.jpg?raw=true) |
![](https://github.com/AlbatovK/Dira/blob/master/assets/note_choose.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/user_list.jpg?raw=true)
![](https://github.com/AlbatovK/Dira/blob/master/assets/search.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/other_profile.jpg?raw=true)
![](https://github.com/AlbatovK/Dira/blob/master/assets/league.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/paging.jpg?raw=true)
![](https://github.com/AlbatovK/Dira/blob/master/assets/enter_dark.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/drawer_dark.jpg?raw=true)
![](https://github.com/AlbatovK/Dira/blob/master/assets/main_dark.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/note_choose_dark.jpg?raw=true)
![](https://github.com/AlbatovK/Dira/blob/master/assets/user_list_dark.jpg?raw=true) | ![](https://github.com/AlbatovK/Dira/blob/master/assets/other_profile_dark.jpg?raw=true)


## License
```
Expand Down

0 comments on commit e08bede

Please sign in to comment.