Skip to content

Repository files navigation

logo This is a simple template for Android apps that follows best practices.

Useful Features

  • UI with Android Compose
  • Library management with Kotlin DSL
  • Modularization
  • Dependency injection with Dagger-Hilt
  • Network calls with OkHttp and Retrofit
  • Local storage with Room
  • Navigation with Navigation Compose

Getting Started

  1. Create a repository that uses this repository as a template
  2. Open the project in Android Studio
  3. In app/res/values/string.xml, change app_name to your desired application name
  4. In settings.gradle.kts, change rootProject.name to your desired application name
  5. In every app module build.gradle.kts, change namespace and applicationId to your desired package name
  6. In all the other module level build.gradle.kts, change namespace to the corresponsing package name. For example, if your package is com.alexru.myapp, change the namespace for the data-local module to com.alexru.data_local
  7. Refactor and rename the project folders. Screenshot 2024-10-06 181620 Select All Directories in the popup menu and rename the package to your desired package name. Make sure the scope is Project Files. Do this for every module.
  8. Sync Gradle scripts in the File menu. You can also press Ctrl+Shift+O.
  9. Clean and rebuild the project in the Build menu.

How to Use

If you're unsure what to do, I highly recommend Clean Android Architecture by Alexandru Dumbravan. The book is somewhat outdated, but it still has a lot of good information about clean architecture. I also recommend videos by Philipp Lackner. He has some good videos about multi-moduled projects and clean architecture. There is a decent amount of flexibility with this template, so you can do whatever you want!

About

Template for multi-module Android apps that uses clean architecture.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Contributors

Languages