Skip to content
/ MVVMTemplate Public template

An Android Template with MVVM and Clean Architecture

License

Notifications You must be signed in to change notification settings

Drjacky/MVVMTemplate

Repository files navigation

MVVMTemplate 🧞‍

Language License Actions Status Build Status Quality Gate Status FOSSA Status Android Arsenal CodeScene Code Health

A simple Android template that lets you create an Android project quickly.

How to use 👣

Just click on Use this template button to create a new repo starting from this template.

Compose version ⭐

For the compose version, which is under development, switch to feature/compose branch.

Features 🕹

Under Development 🚧

  • Add CI
  • Use Kotlin DSL
  • Add Espresso, Instrumentation & Unit tests. To see a part of changes, click here.
  • Use Animations. To see changes, click here.
  • Use Hilt. To see changes, click here.
  • Migrate to Hilt 2.31. To see changes, click here.
  • Use Paging V3. To see changes, click here.
  • Use ViewBinding. To see changes, click here.
  • Migrate to JetPack Compose
  • Use detekt. To see changes, click here.
  • Add coroutines and flow. To see changes, click here.
  • Replace Preferences by DataStore. To see changes, click here.
  • Migrate from RxJava 2 to RxJava 3. To see changes, click here.
  • Add Custom Rx Adapter for Network Response Handling. To see changes, click here.

CI 🏭

This template is using GitHub Actions as CI.

Available workflows listed as follows:

Tasks 🔧

  • Gradle Doctor: dependencyUpdates - Displays the dependency updates for the project.
  • Detekt: detektAll - Run the static Kotlin code analysis for the whole project at once.
  • The Dependency Analysis: buildHealth - Provides advice for managing dependencies and other applied plugins.
  • Sonatype Scan Gradle Plugin - AKA Sherlock Trunks: ossIndexAudit - Scans the dependencies of a Gradle project using Sonatype platforms; OSS Index and Nexus IQ Server.

References 🧷

Contributing 🤝

Feel free to open an issue or submit a pull request for any bugs/improvements.

Result 📺

Compose

License ⚖️

FOSSA Status