- Android
- iOS
- Web (JS)
- Desktop (Windows, MacOS, Linux)
- Backend (Server)
All target platforms are optional and will be included only if selected during configuration, along with any features.
The template follows the general principals:
- The underlying architecture is minimalistic, pre-configured, and complies with the latest recommended guidelines.
- Third-party dependencies, components, DevOps practices, and configurations are optional and can be included or excluded through an online service Kotli.
- All out-of-the-box solutions work seamlessly across all supported platforms and are designed to accelerate the development of complex and production-ready applications within days, prioritizing simplicity and efficiency during the implementation and support phases.
!IMPORTANT! The given template is a Kotli Template.
To generate the required project structure, use online service Kotli (it's free and only requires an internet connection).
Once you configure the necessary features and generate the archive with source codes, you'll have a ready-to-use and working project structure that can be imported into your IDE to begin adding the required business logic.
The template will also include all necessary showcases to make understanding of the included features easy.
Run your project to check what is included and how it works, and once everything is clear, remove the package with showcases and any references to it.
The overall client architecture follows the recommended guidelines and is built on:
- Compose Multiplatform UI Framework
- Compose Multiplatform Images and resources
- Jetpack Compose
- Jetpack Navigation
- Jetpack Lifecycle
- Jetpack ViewModel
- Material 3 Design
- Koin Dependency Injection
Application logic is implemented in the app module and contains only app-specific behavior.
All common logic is part of the shared group, which is split into three modules:
- presentation - architectural solutions to integrate app components with each other.
- data - data sources to use in the app.
- design - the design system of the app (fonts, themes, UI components, etc.).
These modules are used only at the app level. This approach lets you develop all three components independently and create a more complex app structure. For example, app-specific features can be implemented as separate modules, having the same shared dependencies.
Provides architectural solutions to implement user flows and integrate all components with each other in a lifecycle-aware manner.
It includes:
- MVVM pattern implementation - based on the Jetpack ViewModel and Jetpack Lifecycle components.
- Navigation implementation - based on the Jetpack Navigation component.
- Store implementation - initially based on UI State, but more flexible like Pinia.
The included solutions are not mandatory to follow, as all required dependencies are properly included to enable you to use your own patterns with Jetpack components.
However, the provided implementations are very intuitive to use and cover all possible cases of communication between components in various real-life scenarios.
Feel free to choose what fits your needs best.
Provides a fundamental implementation of commonly used data sources in different apps. During project setup via Kotli, only the required data sources will be included.
All data sources have been configured to access the necessary data layer in a flexible and convenient manner.
Provides pre-configured themes, fonts, and UI components to establish the initial Design System of the entire app.
The default module implementation is based on the Google Material 3 Design, which offers all fundamental UI components and guidelines out of the box, enabling the creation of your own Design System with ease.
In addition to the Material 3 library, the module implements several components and containers used in different user flows.
The main idea of this module is to create a Design System that can be used by any UI feature of the app without dependency on the underlying UI kit.
Existing composables in this module are examples and can be changed/removed based on your needs.
The Application module itself contains:
- Logic to properly connect all included components together with the help of Dependency Injection (Koin, by default).
- Showcases to demonstrate some features included during project setup.
Once you download and import the initial project structure into your IDE, the project is ready to run on a device, enabling you to understand the included functionality and start adding the required features.
The server architecture is based on either the Ktor Framework or Spring Boot.
Backend-specific logic is implemented in the backend module.
To enable sharing some common models between the backend and frontend, the project also includes a domain module as part of the shared group.
Once you've configured your project through Kotli and downloaded the generated source codes, this project become fully yours and is not bound to the service. Each project includes a README.MD file in its root with the following helpful details:
- A link to the initial template used to prepare the project structure (GitHub page of the template, similar to this one).
- A link to the architecture (Kotli project) used to prepare and download these sources.
- A list of all features included in the project during its setup. Each feature includes additional documentation within the project's
docsdirectory, making it easy to check what is included, find official links, and understand how to use and configure each functionality if needed.
All documentation related to features can also be found and accessed online, up-to-date, once you open the link to your Kotli project.
When a project is configured and downloaded via Kotli, it also provides showcases of all included features. Furthermore, the screen with showcases is configured as the initial screen when running the downloaded template.
| Showcases :: Overview | Showcases :: Theme Dialog | Showcases :: Key-Value Storage |
|---|---|---|
 |
 |
 |
Once the project is downloaded, it includes the source code as well as a README.md file. This file visualizes all the features included as a table. The most useful columns in this table are:
- Overview - A summary of the feature, including all official resources used to pre-configure this feature in the template. Use it as a reference to find any additional information related to the feature.
- Usage - The main information related to using the feature. Use it as a starting point when you need to start working with the feature and don't know how to begin.
For example, if you configured the project with Web and iOS platforms but don't know how to run the app on them (💀), find these platforms in the table and open their Usage guide.
The template is highly configurable, allowing you to include only the necessary features in the app.
All these features are optional, will be updated over time, and can be included in the generated structure during project setup.
The generated project will include a similar table in its README.MD file, but with only the configured features (direct and transitive).
| Group | Feature | Overview | Configuration | Usage |
|---|---|---|---|---|
| Essentials | Compose Multiplatform | Link | - | - |
| Essentials | Jetpack Navigation | Link | - | Link |
| Essentials | Material 3 | Link | - | Link |
| Essentials | Koin | Link | - | - |
| Essentials | Gradle (Kotlin DSL) | Link | - | - |
| Platform | iOS | Link | - | Link |
| Platform | Android | Link | - | Link |
| Platform | Desktop | Link | - | Link |
| Platform | Web (JS) | Link | - | Link |
| Platform | Ktor Server | Link | - | Link |
| Dataflow | Facade Analytics API | Link | - | Link |
| Dataflow | Facade Config API | Link | - | Link |
| Dataflow | SQLDelight | Link | - | Link |
| Dataflow | Multiplatform Settings | Link | - | Link |
| Dataflow | Basic In-Memory Cache API | Link | - | Link |
| Dataflow | Ktor Client | Link | - | Link |
| Dataflow | Cash App Paging Library | Link | - | Link |
| Userflow | Rail Navigation | Link | - | Link |
| Userflow | Permanent Navigation | Link | - | Link |
| Userflow | Modal Navigation | Link | - | Link |
| Userflow | Dismissible Navigation | Link | - | Link |
| Userflow | Bottom Navigation | Link | - | Link |
| Userflow | Adaptive Navigation | Link | - | Link |
| Userflow | Save Theme API | Link | - | Link |
| Userflow | Change Theme Screen | Link | - | Link |
| Userflow | Toggle Theme Button | Link | - | Link |
| Userflow | Data Loading Indicator | Link | - | Link |
| Testing | Kermit | Link | - | Link |
| Testing | Napier | Link | - | Link |