KMP/CMP Template

A template to jumpstart KMP/CMP projects with modularization, clean architecture, MVVM and UDF.

This project uses:

• Ktor for networking
• Kotlin Coroutines for asynchronous tasks
• Jetpack Navigation for screen transitions
• Jetpack DataStore for local persistence
• Firebase for app distributions
• JUnit5 and Mokkery for testing

UI Design

This is not a full-fledged photo album. It’s just a simple photo viewer to help you jumpstart setting up your own project.

Get the Precompiled App

• iOS - Automatically compiled and distributed after email registration (usually within 20 minutes)
• Android - Please, manually compile from the source (for now)

Set up the Project

💡 If you prefer to try this project without Firebase, switch to the remove-firebase branch. Eliminating the need for this separate branch is on the roadmap.

1. Follow the official guide to set up the KMP development environment.
2. Clone the repo.
3. (Only for main branch) Setup Firebase for Android by following the official guide. Place google-services.json in the composeApp directory.
4. (Only for main branch) Setup Firebase for iOS by following the official guide. The initialization code is already added—just place GoogleService-Info.plist into the iosApp/iosApp/ directory.
5. Open the project in Android Studio.
6. If you get a NoToolchainAvailableException, install JDK 24. If you don't get this error, you can skip this step.
7. Swift packages should be automatically resolved by Android Studio. If not, please update your Android Studio.
8. There's a dropdown menu beside the Run button in Android Studio. That's where you choose the target platform.
9. Enjoy!

Testing

Refer to the dedicated page for testing.

Roadmap

• Set up spacer sizes in terms of XXS, XS, S, M, L, XL and so on instead of hardcoded DPs to easily unify size
• Figure out a way to resolve Firebase dependencies in CI/CD for iOS to eliminate the need for a separate branch. For more details on why this is necessary, please refer to this Linkedin post
• Write an Android Studio plugin to help developers easily generate fakes(test doubles) to use with integration tests
• Write instrumentation tests to ensure things work as expected on real devices
• Use paging3 in PhotoListScreen to support pagination
• Figure out which snapshot test framework would be best suited for the project
• Set up snapshot tests
• Implement Talaiot to analyze Gradle tasks
• Implement AES-GCM encryption for session storage to enhance security
• Implement remote Gradle cache for the iOS CI/CD pipeline
• Use Spotless to sort the keys in version catalog to make searching keys easier

CI/CD

• iOS
• Android (Coming Soon)

Contributing

PRs and feedback welcome!

License

Apache 2.0