Android MVVM (Compose) Template

Simple template for MVVM with in Android with Compose.

Architecture

Overview

• Notices
  1. The INTERNET permission is enabled in the Manifest because there's a basic Retrofit2 usage.
  2. BuildConfig is enabled in build.gradle to securely use important variables, such as BuildConfig.API_KEY.
  3. Put important variables in keys.properties. It'll be loaded in build.gradle.
• Core Versions

agp = "8.3.0"
kotlin = "1.9.0"
composeBom = "2024.04.00"
room = "2.6.1"
hilt = "2.51.1"
gson = "2.10.1"
retrofit2 = "2.11.0"
ksp = "1.9.0-1.0.13"
okhttpLogging = "4.12.0"

Usage

1. git clone this repo

git clone https://github.com/jhj0517/android-template-mvvm-xml.git

2. Go to the Project Files tab in the File Tree view within Android Studio.
   • Refactor the organization name with yours
   • Refactor the package name with yours
3. Change the namespace and applicationId in the module-level build.gradle.

android {
    namespace = "com.jhj0517.android_template_mvvm_xml" // Change
    defaultConfig {
        applicationId = "com.jhj0517.android_template_mvvm_xml" // Change
    }
}

4. Change the rootProject.name in the settings.gradle

rootProject.name = "android-template-mvvm-xml" // Change

5. Build -> Clean Project -> Rebuild Project
6. You're now ready to start your new project.