Merge branch 'develop' into prod

Author: MishkaV

.ci/.gitlab-ci.yml

@@ -91,7 +91,7 @@ build-app:
   image: openjdk:11-jdk
   extends: .before_script_template
   rules:
-    - when: always
+    - when: never
   tags:
     - docker_miem
   script:

.detekt/detekt-config.yml

@@ -141,7 +141,7 @@ complexity:
     ignoreArgumentsMatchingNames: false
   NestedBlockDepth:
     active: true
-    threshold: 4
+    threshold: 5
   NestedScopeFunctions:
     active: false
     threshold: 1
@@ -344,10 +344,10 @@ naming:
     active: false
     parameterPattern: '[a-z][A-Za-z0-9]*|_'
   MatchingDeclarationName:
-    active: true
+    active: false
     mustBeFirst: true
   MemberNameEqualsClassName:
-    active: true
+    active: false
     ignoreOverridden: true
   NoNameShadowing:
     active: true
@@ -769,7 +769,7 @@ formatting:
     active: true
     autoCorrect: true
   Filename:
-    active: true
+    active: false
   FinalNewline:
     active: true
     autoCorrect: true

README.md

@@ -1,53 +1,31 @@
-# OdooApp-Android
+# OdooApp
 
+<a href=''><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width=300/></a>
 
-## Описание
-> Приложение мобильный клиент Odoo для платформы Android
+## Description
+> This is **unofficial** [Odoo](https://www.odoo.com/) mobile client for Android with [HSE](https://www.hse.ru/en/) support. Enjoy!
 
-## Общая структура проекта
-- [buildSrc](buildSrc/) - модуль, предназначенный для хранения всех gradle зависимостей, для дальнейшего поделючения во всех остальных модулях
-- [common](common/) - модуль, который содержит в себе функциональный куски кода, которые в дальнейшем можно переиспользовать
-- [.ci](.ci/) - инкапсуляция конфигов для ci/cd
-- [core](core/) - модуль компонентов, которые используются в других модулях проекта
-- [.detekt](.detekt/) - конфиги для `detekt` на ci
-- [entry](entry/) - модуль для входных точек в приложение
-- [feature](feature/) - модуль, который будет описывать логику фичей (например, авторизация)
+## Features
+- Authorization
+  - General
+  - HSE
+- Selecting modules, pick your favorite
+- Recruitment module `coming soon!`
+- CRM module `coming soon!`
+- Profile `coming soon!`
 
-## Git flow
-Есть несколько основных веток
+## Example of screens
+<img src="documentation/screenshots/Authorization_light.webp" width=300/> <img src="documentation/screenshots/Authorization_dark.webp" width=300/>
 
-- prod - стабильная ветка релизов
-- develop - ветка активной разработки, checkout от prod
-- Различные ветки фичей/багфиксов (соостветсвенно по названиям `feature/some_description` и `bugfix/some_description`)
+## Stack
+- Kotlin
+- Jetpack Compose
+- RxJava
+- Clean Architecture + MVVM
+- And other interesting staff
 
-В конце каждого спринта будет релиз:
-- Доливаем все доработки в prod
-- Обновляем github
+## Are you a developer?
+Check [README](documentation/README.md) for developers
 
-## Договоренности
-- Комментарии пишем на **русском**
-- Разделяем по возможности на **api** **impl**, для разделения методов наружу и их реализацией соответсвенно
-- Naming модулей через **camelCase**. Пример - `buildSrc`
-- Naming различных реализаций `impl` через *snake_case*, чтобы четко можно выделить особенносить
-конректной реализации. Пример: 
-```
-    login/
-        api/
-        impl/
-        impl_hse/
-        impl_google/
-```
-- Документация в api модулях очень приветсвуется, как и логгирование
-- Naming пакетов должен быть следующим: 
-`odoo.miem.android.{feature/common/core}.{название модуля}.{api/impl}`  
-  - api/impl - опционально, если присутсвует
-  - Не касаеися `entry/*` модулей, так как там содержиться базовый путь `odoo.miem.android`
-  - Пример: `odoo.miem.android.core.di.impl`
-
-## Как добавить новую gradle зависимость? Что такое модуль buildSrc и зачем он нужен?
-В модуле [buildSrc](buildSrc/) в файле [Dependencies](buildSrc/src/main/kotlin/consts/Dependencies.kt)
-прописаны все gradle зависимости, при необходимости добавляем/обновляем зависимости именно там.
-Подробнее об модуле [buildSrc](buildSrc/) можно почитать в соответсвующем [README.md](buildSrc/README.md)
-
-## Как подключить модуль к общему DI графу?
-Побробнее об этом можно прочитать в соответсвующем [README](core/di/README.md)
+## Download
+Stable release coming soon, keep in touch ＼(＾▽＾)／

build.gradle.kts

@@ -8,9 +8,7 @@ plugins {
 
 buildscript {
     dependencies {
-        Dependencies.Firebase.ALL_GRADLE_PLUGINS.forEach {
-            classpath(it)
-        }
+        Dependencies.Firebase.GRADLE_PLUGINS.forEach { classpath(it) }
     }
 }
 

buildSrc/README.md

@@ -1,24 +1,24 @@
 # BuildSrc модуль
 
-## Назначение
-Данный модуль предназначен для хранения зависимостей и их версий
+## Appointment
+This module is designed to store dependencies and their versions
 
 ## Описание
-Сам модуль имеет следующие разделение:
+The module itself has the following divisions:
 - [const](buildSrc/src/main/kotlin/consts)
   - [CompileVersions](buildSrc/src/main/kotlin/consts/CompileVersions.kt) -
-  нужен для выделения версии сборки проекта
+  needed to highlight the build version of the project
   - [Dependecies](buildSrc/src/main/kotlin/consts/Dependecies.kt) -
-  содержит все нужные версии и зависимости
+  contains all the necessary versions and dependencies
 - [conventions](buildSrc/src/main/kotlin/conventions)
   - [base](buildSrc/src/main/kotlin/conventions/base) -
-  базовые конвенции, которые содержать первоначальные настройки
+  basic conventions that contain the initial settings
   - [module](buildSrc/src/main/kotlin/conventions/module) -
-  конвенции, которые расширяют базовые конвенции минималлного уровня использования
-  - [module_extended](buildSrc/src/main/kotlin/conventions/module_extended) - 
-  специфичные конвенции, которые расширяют конвенции из [module](buildSrc/src/main/kotlin/conventions/module)
+  conventions that extend the basic conventions of the minimum level of use
+  - [module_extended](buildSrc/src/main/kotlin/conventions/module_extended) -
+    specific conventions that extend conventions from [module](buildSrc/src/main/kotlin/conventions/module)
 
-## Процесс расширения
+## The expansion process
 ```
 base -------> module -------> module_advanced
 

buildSrc/src/main/kotlin/consts/CompileVersions.kt

@@ -1,5 +1,5 @@
 /**
- * [CompileVersions] нужен для хранения актуальных версий для сборки проекта
+ * [CompileVersions] is needed for storing actual versions to build the project
  *
  * @author Ворожцов Михаил
  * @since 09.10.2022

buildSrc/src/main/kotlin/consts/Dependencies.kt

@@ -1,6 +1,5 @@
 /**
- * [Dependencies] предназначен для хранения всех зависимостей, которые нужны
- * в данном проекте
+ * [Dependencies] is designed to store all the dependencies that are needed in this project
  *
  *
  * @author Ворожцов Михаил
@@ -112,11 +111,14 @@ object Dependencies {
         object Accompanist {
             private const val VERSION = "0.28.0"
 
-            const val ACCOMPANIST_CORE = "com.google.accompanist:accompanist-pager:$VERSION"
+            const val ACCOMPANIST_PAGER = "com.google.accompanist:accompanist-pager:$VERSION"
             const val ACCOMPANIST_INDICATORS =
                 "com.google.accompanist:accompanist-pager-indicators:$VERSION"
 
-            val ALL_ACCOMPANIST_DEPS = listOf(ACCOMPANIST_CORE, ACCOMPANIST_INDICATORS)
+            val ALL_ACCOMPANIST_DEPS = listOf(
+                ACCOMPANIST_PAGER,
+                ACCOMPANIST_INDICATORS
+            )
         }
 
         object SharedElements {
@@ -216,11 +218,14 @@ object Dependencies {
         const val FIREBASE_BOM = "com.google.firebase:firebase-bom:$BOM_VERSION"
         const val FIREBASE_ANALYTICS = "com.google.firebase:firebase-analytics-ktx"
         const val FIREBASE_CRASHLYTICS = "com.google.firebase:firebase-crashlytics-ktx"
+        const val FIREBASE_CONFIG = "com.google.firebase:firebase-config-ktx"
 
-        val ALL_GRADLE_PLUGINS =
+        val GRADLE_PLUGINS =
             listOf(GOOGLE_SERVICES_GRADLE_PLUGIN, FIREBASE_CRASHLYTICS_GRADLE_PLUGIN)
 
-        val ALL_DEPS = listOf(FIREBASE_ANALYTICS, FIREBASE_CRASHLYTICS)
+        val APPLICATION_DEPS = listOf(FIREBASE_ANALYTICS, FIREBASE_CRASHLYTICS)
+
+        val MODULE_DEPS = listOf(FIREBASE_ANALYTICS, FIREBASE_CONFIG)
     }
 
     object Plugins {

buildSrc/src/main/kotlin/conventions/base/conventions.base-api.gradle.kts

@@ -2,9 +2,9 @@ import org.gradle.kotlin.dsl.withType
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 /**
- * Базовая конвенция для api модулей
+ * Basic convention for api modules
  *
- * @author Ворожцов Михаил
+ * @author Vorozhtsov Mikhail
  * @since 09.10.2022
  */
 plugins {

buildSrc/src/main/kotlin/conventions/base/conventions.base-app.gradle.kts

@@ -1,9 +1,9 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 /**
- * Базовая конвенция для app модулей
+ * Basic convention for app modules
  *
- * @author Ворожцов Михаил
+ * @author Vorozhtsov Mikhail
  * @since 09.10.2022
  */
 plugins {

buildSrc/src/main/kotlin/conventions/base/conventions.base-impl.gradle.kts

@@ -3,10 +3,10 @@ import org.gradle.kotlin.dsl.withType
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 /**
- * Базовая конвенция для api модулей, которая не содержит
- * подключаемые завивисимости
+ * Basic conventions for api modules which doesn't contains
+ * pluggable dependencies
  *
- * @author Ворожцов Михаил
+ * @author Vorozhtsov Mikhail
  * @since 15.09.2022
  */
 plugins {