MobileUp CMP Template 🌀

Hi! This is a template for initializing a Compose Multiplatform project in MobileUp.

Creating Project

After cloning the template:

1. Run the setup script to configure your application ID and JIRA key:
   ./scripts/setup-project <new.application.id> <JIRA_PROJECT_KEY> for Windows see
2. Update AGENTS.md for your concrete product context.
3. Replace application name and icon with project-specific assets.
4. Remove the demo pokemons feature and related wiring.
5. Replace error text resources with product text.
6. Build a project-specific CustomTheme and reusable widget set in core.
7. Continue with product feature implementation.

Modules

The project is based on three gradle modules:

core

It contains general purpose things: error handing, message showing, network, theme, utils, reusable widgets.

features

It consists of concrete features. Each feature has its own package which contains:

• DI configuration
• presentation layer - components, Compose UI
• domain layer - entities, queries, pure functions
• data layer - repositories, storages

shared

It combines all features and provides the SharedApp entry point for platform apps.

androidApp

Android entry points, icon resources, build configurations, Android-specific integrations, and launch of shared.

iosApp

Xcode project, SwiftUI entry point, assets, iOS-specific integrations, and launch of shared.

Features structure

Technology stack

• Compose Multiplatform - UI
• Decompose - componentization and navigation
• Replica - organizing of network communication
• Koin - Dependency Injection
• Ktor - Network
• Ktorfit - network requests in Retrofit way
• Coroutines - asynchronous operations
• Kotlin Serialization - JSON serialization and parsing
• Kotlinx DateTime - date/time models
• Coil - image loading
• Settings + SettingsFactory abstraction - local settings storage
• Security Crypto - secure storage primitives
• Detekt - static code analysis
• Hyperion - debug panel
• Module Graph Gradle Plugin - feature dependency graph visualization and validation

Git hooks

To install the Git hooks for commit checks and automatic issue prefixes, simply run: ./scripts/setup-git-hooks for Windows see

Calling scripts for Windows

1. Install Git Bash
2. Go to your project folder and open Git Bash here (right click)
3. If your pre-commit failed by OUTPUT_MODULE_GRAPH_GENERATE. Download and install Graphviz for Windows. During installation, select "Add Graphviz to the system PATH for all users." and Reboot.
4. It is important to ensure that the java in the project (Project structure) matches the java in JAVA_HOME (environment variables)

Compose detekt rules docs

https://mrmans0n.github.io/compose-rules/

Good coding and happy day!🤘

License

MIT License

Copyright (c) 2026 MobileUp

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.