Android Starter

A starter template for Android app project that implements Clean Architecture. Dagger2 is used for dependency injection. Base classes for implementing MVVM are also included in this starter project although you are free to implement other design patterns if needed.

Prior knowledge with Clean Architecture is required to use this starter project.

Following the Clean Architecture guidelines, the project is divided into 3 modules: domain, data, and app (presentation)

For further reading about Clean Architecture

Setup

• Rename packages from com.snekbyte.starter to a name of your choice. Make sure the changes are applied to all three layers (domain, data, app)
• Change the package attribute on the AndroidManifest.xml file. This should not be exactly the same as the app layer's package attribute or else the project will build but will fail to resolve the R class properly.
• Change the applicationId property on app/build.gradle

Usage

• Use Cases can be created by implementing the UseCase interface
• Dependencies are managed inside the dependencies.gradle file for easier tracking of libraries across multiple modules

ViewModels and Dependency Injection

ViewModels should use an @AssistedInject constructor and should include its own Factory with @AssistedFactory annotation. Parameters should also have the @Assisted annotation.

class CustomViewModel @AssistedInject constructor(
  @Assisted savedStateHandle: SavedStateHandle
): ViewModel() {
  @AssistedFactory
  interface Factory {
    fun create(savedStateHandle: SavedStateHandle): CustomViewModel
  }
}

On your dagger component:

@Component
interface AppComponent {
  fun customViewModel(): CustomViewModel.Factory
}

Use the lazyViewModel delegate to initialize ViewModels

private val viewModel: CustomViewModel by lazyViewModel { stateHandle ->
  appComponent().customViewModel.create(stateHandle)
}

TODO:

• Make a demo app
• More detailed guide