android sample app

Разработка

API -ключ

Чтобы запустить приложение, вам необходимо предоставить ключ API из TMBD. Когда вы получите ключ, добавьте следующую переменную в вашу локальную среду:

API_KEY_TMDB = Your API Key

Как установить переменную среды в Mac / Windows

Стиль кода *

Для поддержания стиля и качества кода используются инструменты Bellow Static Analysis. Все они используют должным образом конфигурацию, и вы найдете их в config/.{toolName} .

Инструменты	Файл конфигурации	Проверьте команду	Исправить команду
Детект	.detekt.yml	./gradlew detekt	-
ktlint	-	./gradlew ktlint	./gradlew ktlintFormat
безупречный	-	./gradlew spotlessCheck	./gradlew spotlessApply
пронзительный	.lint.xml	./gradlew lint	-
плагин Gradle Versions	-	./gradlew dependencyUpdates	-

Все эти инструменты, за исключением плагина Gradle Versions, интегрированы в предварительную git крючку, чтобы убедиться, что весь статический анализ и тесты проходят, прежде чем вы сможете совершить свои изменения. Плагин Gradle Versions можно запустить необязательно. Чтобы пропустить их для конкретного коммита, добавьте эту опцию в вашей команде GIT:

git commit --no-verify

Настоятельно рекомендуется исправить разбитые стили кода. Есть задача Gradle, которая выполняет для вас ktlintFormat и spotlessApply :

./gradlew reformat

Предварительные крючки GIT имеют точно такие же проверки, как и Circleci, и определены в этом сценарии. Этот шаг гарантирует, что все коммиты соответствуют установленным правилам. Однако в конечном итоге будет подтверждена непрерывная интеграция, что изменения верны.

Если вы хотите узнать больше о конвенции об именах, стиле кода и больше, пожалуйста, посмотрите на наш репозиторий для Android.

Архитектура

• Единственная деятельность
• Образец MVVM

Просмотр: рендерирует пользовательский интерфейс и делегирует действия пользователя в ViewModel

ViewModel: может иметь простую логику пользовательского интерфейса, но большую часть времени просто получает данные от usecase

USECASE: содержит все деловые правила, и они написаны в принципе единой ответственности

Репозиторий: единственный источник данных. Отвечает за получение данных из одного или нескольких источников данных

Технический стек

Зависимости

• Навигационный компонент: последовательная навигация между представлениями
• LiveData: наблюдаемый и держатель данных, осведомленный жизненный цикл и владелец данных
• ViewModel: хранит данные пользовательского интерфейса через изменения конфигурации
• DataBinding: привязывает компоненты пользовательского интерфейса в макетах с источниками данных
• Кинжал: инжектор зависимости
• Coroutines: асинхронное программирование
• Глид: загрузка изображения и кэширование
• Лотти: анимация на основе JSON
• Модернизация: введите Safe HTTP -клиент
• Моши: JSON Serializer/Deserializer
• Комната: картирование объекта для SQLite
• Paging3: загружать и отображать страницы данных

Плагины

• Detekt: анализ статического кода для Kotlin
• Безупречный: держите свой код безупречным
• Ktlint: Kotlin Linter
• Lint: Статические инструменты анализа программы
• Плагин Gradle Versions: контроллер версий зависимости

Лицензия

 Copyright 2020 adesso Turkey

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.