Nanamare/Starter

Android Starter Pack

Starter for modern android development

Here is a simple project starter pack for Android developers.

Archtecture

• Following MVVM Design Pattern
• UI Layer -> Domain Layer -> Data Layer dependency flow

How to use? Just download or fork :)

Features

• Kotlin (Coroutine, Flow)
• Kotlin DSL
• Jetpack
  • Compose
  • Navigation
  • ViewModel(AAC)
  • Paging3
• Material-Components
• Dagger-Hilt
• Retrofit
• OkHttp
• Kotlinx-serialization
• Accompanist
  • SwipeRefresh
  • System-ui-controller
• Coil
• Room (RemoteMediator - Room paging)
• Timber
• UnitTest
  • JUnit
  • Kotlinx-coroutines-test
  • Truth(Google)
  • Mockito
  • OkHttp(MockWebServer)
  • Arch Core-testing
• AndroidTest(Instrumentation Test)
  • Expresso
  • Compose-ui-junit
  • Hilt-android-testing
• Debugging
  • Flipper
    • LeakCanary(MemoryLeak detection)
    • Database(Room)
    • Layout debugging
    • Navigation
    • Network
    • Shared Preference

Dependency Management

• Version Catalog (TOML)

CI

This repository is using GitHub Actions

Modularization

• App (UI Layer) android dependencies
• Data (Data Layer) network, datasource dependencies
• Domain (Domain Layer) Pure kotlin, java (business logic)
• Base (Collection of utility functions used in UI Layer, smilarity android-core library)
• build-logic (Managing dependencies)
• Test-shared (UnitTest, AndroidTest)

ETC

• There is a precommit hook that adds the branch name to the commit.
• Using plugins
• Library Version

TODO

• Detekt (inner precommit hook)
• Renovate (Managing recently library version)

⭐ Thank you for your ⭐