Caution

Android Gradle Plugin version 7.0.0 and upwards require Java 11 to run. Possible solutions for the issue.

Development

To maintain the style and quality of the code, are used the bellow static analysis tools. All of them use properly configuration and you find them in the project root directory config/{toolName}.

Tools	Config file	Check command	Fix command
detekt	detekt.yml	./gradlew detekt	-
ktlint	-	./gradlew ktlint	./gradlew ktlintFormat
spotless	-	./gradlew spotlessCheck	./gradlew spotlessApply
lint	lint.xml	./gradlew lint	-

All gradle tasks are integrated in pre-commit git hook, in order ensure that all static analysis and tests passes before you can commit your changes. To skip them for specific commit add this option at your git command:

git commit --no-verify

It's highly recommended to fix broken code styles. There is a gradle task which execute ktlintFormat and spotlessApply for you:

./gradlew reformat

Tech Stack

Dependencies

• Navigation Component: Consistent navigation between views
• LiveData: Lifecycle aware observable and data holder
• ViewModel: Holds UI data across configuration changes
• DataBinding: Binds UI components in layouts to data sources
• Dagger-Hilt: Dependency injector
• Coroutines: Asynchronous programming
• Coil: Image loading and caching
• ExoPlayer: Media player for Android
• Kotlinx.Serialization: JSON serializer/deserializer
• Retrofit: Type safe HTTP client
• ThreeTenABP: Android compatible date and time API
• Timber: Logging library for Android
• LeakCanary: Memory leak detection library for Android
• Chucker: HTTP inspector for Android & OkHTTP

Plugins

• Detekt: Static code analysis for Kotlin
• Spotless: Keep your code spotless
• Ktlint: Kotlin linter
• Lint: Static program analysis tools