Template project for starting android development. Although it grew to be more of a showcase of different feature implementations, most of which are contained on Home screen:
- Passing navigation arguments forward and backward.
- Animated splash screen.
- Linters in Github actions.
- Gradle tasks and convention plugins.
- Exoplayer implementation with custom controls overlay.
- In-app camera implementation.
- Barcode scanning with ML Kit.
- Custom CompositionLocal for colors (partly shown on Feature tab).
- SMS authentication with firebase in sms-authentication branch.
- Connecting to Wi-Fi networks.
- Multiple app themes.
Splash screen
Initial functionality
Exoplayer video playback
Themes
| Feature | Short description |
|---|---|
| Architecture | Feature modules |
| DI | Hilt |
| UI | Compose and MVI |
| Navigation | Compose navigation |
Feature modules, each divided into two parts: api and impl.
Api modules only contain logic for navigating to this module, and don't rely on other modules.
It's preferable to put all logic into objects with Destination suffix, such as HomeDestination.
Members naming inside the Destination object is not enforced (but can be via an interface),
however this template uses ROUTE constant for adding the route to the NavGraph, and
constructRoute() for returning a string with arguments to be used for navigating to this route.
Impl modules contain screens, implementation for the navigation, and can rely on other api modules for navigating to them.
Naming scheme of modules and packages is camelCase (homeApi, com.package.homeImpl).
Single Activity containing bottom navigation bar and Compose screens.
UI architecture: MVVM with MVI. State is passed to UI, Events are passed to ViewModel. No Effects.
Custom CompositionLocalProvider was added to AppTheme for providing AppColors (link). Provided colors can be configured as needed by the design. Moreover it's possible to add other design components, like fonts, and thus mostly replace MaterialTheme.
BaseVM is a base class for ViewModels.
Compose navigation. Routes are created with the help of api modules.
Singleton NavManager is used to abstract navigation and move navigation command triggering to ViewModels. Stream of navigation commands is observed in the module responsible for navigation (currently :app).
Version catalogs are used for version management.
Convention plugins are added in buildSrc for easier management of build.gradle files. Main plugins are:
- convention-linters - adds and configures detekt and ktlint plugins.
- convention-android-library - uses convention-linters, sets up general settings in android{} extension, which are shared with all android library modules. Mainly used for core and api feature modules.
- convention-feature-module - uses convention-android-library, sets up additional dependencies (Hilt, Navigation, Compose), which are useful for all impl feature modules.
Convention plugins introduce some issues when using version catalogs in them, especially in
plugins{} blocks, so some workarounds were applied where possible.
In addition to Android Studio's module creation, a custom gradle task createLibraryModule was
added, that automatically adds build.gradle with convention plugins to the new module.
Source: CreateAndroidModuleTask.kt. Example, creating module 'module1' in subdirectory 'feature':
./gradlew createLibraryModule --name :feature:module1
Another gradle task renamePackage can be used to quickly rename packages, references to them,
and directories. There is also renamePackageForce version, which can overwrite existing files
when moving directories. Warning: this task modifies files irreversibly, so caution should be
exercised.
Source: RenamePackageTask.kt. Example usage:
./gradlew renamePackage --from com.featuremodule --to my.new.package
Configuration for all custom tasks can be found in root build.gradle.kts.
Fox vector icon is made by UIcons