mafujuls/MVVMTemplate

An Android Template with MVVM and Clean Architecture

MVVMTemplate 🧞‍

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

How to use 👣

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

Features 🕹

• 100% Kotlin-only template
• Following Clean Architecture approach
• Following MVVM Architectural Design Pattern
• Pull Request Template
• Simplest Adapter Ever (based on this workaround)
• Github Actions - CI
• Hilt - Dependency Injection framework
• Transition - Animation
• Paging V3 - Pagination
• OkHttp3 - Network interceptor
• Retrofit - HTTP client
• Glide - Loading images
• Timber - Log
• Gson - JSON library
• Material Components - Material Design
• Lottie - Vector animation library

Under Development 🚧

• Add CI
• Use Kotlin DSL
• Add Espresso, Instrumentation & Unit tests
• Use Animations. To see changes, click here.
• Use Hilt. To see changes, click here.
• Use Paging V3. To see changes, click here.

CI 🏭

This template is using GitHub Actions as CI.

Available workflows listed as follows:

• Validate Gradle Wrapper - Checks the gradle wrapper has a valid checksum.
• Pre Merge Checks - Runs build task.
• Android - Runs assembleDebug task.

Contributing 🤝

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

Result 📺