drjacky / 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.

Compose version ⭐

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

Features 🕹

• 100% Kotlin-only template
• Following Clean Architecture approach
• Following MVVM Architectural Design Pattern
• Template Project
• RxJava 3 - Reactive Extensions for the JVM
• Coroutines - A concurrency design pattern library
• Flow - Built on top of coroutines and is stream of data that can be computed asynchronously
• Simplest Adapter Ever (based on this workaround)
• Github Actions - CI
• Hilt - Dependency Injection framework
• Transition - Animation
• Paging V3 - Pagination
• View Binding - View Binding
• OkHttp3 - Network interceptor
• Retrofit - HTTP client
• Glide - Loading images
• Timber - Log
• Gson - JSON library
• Material Components - Material Design
• Lottie - Vector animation library
• Kotlin DSL - Alternative syntax to the Groovy DSL
• Detekt - Static code analysis for Kotlin
• Gradle Doctor - Gradle build scan plugin
• Navigation - Navigate through the app
• LeakCanary - Memory leak detection
• Chucker - An HTTP inspector for Android & OkHTTP
• StrictMode - A developer tool which detects things you might be doing by accident
• Dark/Light Theme - Support dark/light themes
• DataStore - Data storage solution that allows you to store key-value pairs or typed objects
• AutoDispose - Automatically binding the execution of RxJava streams to a provided scope
• Dependency Analysis
  • Dependency analysis android gradle plugin
• Sonatype Scan Gradle Plugin- Gradle plugin that scans the dependencies of a Gradle project using Sonatype platforms: OSS Index and Nexus IQ Server.

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:

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

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 🧷

• The Punk API
• Right or Left animation by Marco Martina on LottieFiles
• Loading Beer animation by Hashim Irfan on LottieFiles

Contributing 🤝

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

Result 📺

Compose

License ⚖️

mvvmtemplate's Issues

I am unable to inject main activity in base fragment

How can i inject main activity in fragment?

@Inject
lateinit var mainActivity: MainActivity

Empty screen instead of no internet connection view

When choosing a coroutine button, no internet connection view is displayed. After the mobile device screen is off and then on, the view will be gone as you see in the attached video.

What is the best way to implement a use case that doesn't have any params?

Do I need to create a separate base use case that doesn't expect params to be passed, or just pass Void as param? what would be your way to handle that ?

How would the ProductsPagingSourceByCoroutine looks like for normal api call that doesn't support paging

[BUG]: Showing the loading animation on the loaded list

Describe the bug
Showing the loading animation on the loaded list
To Reproduce
Steps to reproduce the behaviour:

1. Internet & Fetch
2. No Internet & See Error
3. Internet & Retry
4. Rotate & No Internet
5. Fetch & See Error
6. Internet & Retry
7. Rotate

Expected behaviour
Ater following flow, must not see the loading

Screenshots

How to include a foreground location service with this architecture?

Hi Drjacky,

I want to add a foreground location service in my app (which is based on clean architecture MVVM pattern).

I want to know, in which manifest file, do I need to put the location permissions.

I believe it should be in the app module manifest file, but then during runtime, when I will check for the app permissions from my fragment, I need access to my app module (because manifest file with permission is located there).

So, if I tell my presentation module about the app module, this would breach the clean architecture principle.

In my current project:

• Domain knows nothing

• Data knows about Domain

• Presentation knows about Domain

• And App knows all the three

Edited: Never mind, I believe we have to add the permission in both the manifests, because:

1. When added only in presentation module, the app crashes
2. When added only in app module, there is a compiler error

Thanks again for your repo.

Thanks
Relive

[BUG]: Title goes here

Please provide a video showcasing how this template can be used. If you really want to use this as a template it should be easy to use another REST API by simply changing some data structures, layouts being used, etc., as this project is so massive (unbelieable how much work you put in it), it is difficult to find where to start and where to change something.

[BUG]: Title goes here

I don't understand why you have all those folders domain, presentation etc outside the app module, is this project supposed to be opened with Android Studio and work? Because it's not a typical Android project, I'm not being able to simply open it and run it.

[BUG]: JAVA_HOME is not set.

Describe the bug
A problem occurred configuring root project 'MVVMTemplate'.

=============================== Gradle Doctor Prescriptions ============================================
| JAVA_HOME is not set. |
| Please set JAVA_HOME so that switching between Android Studio and the terminal does not trigger a fu |
| ll rebuild. |
| To set JAVA_HOME: (using bash) |
| echo "export JAVA_HOME=$(/usr/libexec/java_home)" >> ~/.bash_profile |
| or ~/.zshrc if using zsh. |
| |
========================================================================================================

To Reproduce
Steps to reproduce the behaviour:

1. Open this project template in macos.

Expected behaviour
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Smartphone (please complete the following information):

• Device: [e.g. Pixel 3]
• OS: [e.g. Android10]
• Version [e.g. 30]

Additional context
Add any other context about the problem here.

Could not clone: Drjacky/MVVMTemplate is not a template repository.

Getting Could not clone: Drjacky/MVVMTemplate is not a template repository while cloning

Hi i am following your template based on MVVM, But i was confused in how to forward data from view to data layer. would you please explain with login example?

[BUG]: Showing no internet screen after rotation

Describe the bug
Showing no internet error after rotation

To Reproduce
Steps to reproduce the behaviour:

1. Be sure there is an internet connection
2. Fetch data
3. Scroll one page
4. Disconnect the internet
5. See the error screen
6. Connect the internet
7. Fetch data (optional)
8. Rotate the device
9. You must not see the error screen but, you see!

Expected behaviour
After the error screen is gone, we must not see the error screen (without changing any condition) on the other orientation

Screenshots
N/A

Smartphone (please complete the following information):

• Device: Pixel 3
• OS: 10
• Version 29

Additional context
N/A

Memory leak

Memory leaks happened many times.

Are you planning to add persistence feature?