You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
dima.avdeev d2b9faa72e
examples README and .run configurations (#2355)
2 years ago
..
.run examples README and .run configurations (#2355) 2 years ago
android TodoApp. Updated Decompose to 0.5.1 and MVIKotlin to 3.0.0-beta01. (#1896) 2 years ago
buildSrc Fix todoapp sample, iOS build (#2024) 2 years ago
common Fix todoapp sample, iOS build (#2024) 2 years ago
desktop corrrect package name in nativeDistributions (#1042) 3 years ago
gradle/wrapper update gradle wrapper 7.5.1 (#2352) 2 years ago
ios Fix todoapp sample, iOS build (#2024) 2 years ago
screenshots Update TodoApp example readme with Web app (#796) 3 years ago
web web: update web examples to 1.0.0-rc12 (#1517) 3 years ago
.gitignore Unify .gitignore across all examples and templates 4 years ago
README.md examples README and .run configurations (#2355) 2 years ago
browser-run-configuration.png examples README and .run configurations (#2355) 2 years ago
build.gradle.kts Free todoapp from jcenter (#592) 3 years ago
desktop-run-configuration.png examples README and .run configurations (#2355) 2 years ago
gradle.properties Update Kotlin version 2 years ago
gradlew Rename app folder to todoapp 4 years ago
gradlew.bat Rename app folder to todoapp 4 years ago
settings.gradle.kts Add web app for the TodoApp example (#778) 3 years ago

README.md

An example of Kotlin Multiplatform todo app with shared Android/Desktop Compose UI and SwiftUI (not Compose) iOS.

This example supports the following targets:

  • Android (Compose)
  • Desktop/JVM (Compose)
  • Web/JavaScript (Compose)
  • iOS (SwiftUI, not Compose)

Libraries used:

  • Jetpack Compose - shared UI
  • Decompose - navigation and lifecycle
  • MVIKotlin - presentation and business logic
  • Reaktive - background processing and data transformation
  • SQLDelight - data storage

There are multiple modules:

  • :common:utils - just some useful helpers
  • :common:database - SQLDelight database definition
  • :common:main - displays a list of todo items and a text field
  • :common:edit - accepts an item id and allows editing
  • :common:root - navigates between main and edit screens
  • :common:compose-ui - Shared Compose UI for Android and Desktop
  • :android - Android application
  • :desktop - Desktop application
  • :web - Web browser application + Compose Web UI
  • ios - iOS Xcode project

The root module is integrated into Android, Desktop and iOS (non-Compose) apps.

Features:

  • 99% of the code is shared: data, business logic, presentation, navigation and UI
  • View state is preserved when navigating between screens, Android configuration change, etc.
  • Model-View-Intent (aka MVI) architectural pattern
  • Pluggable UI - Compose UI for Android, Desktop and Web, SwiftUI (not Compose) for iOS

Running desktop application

  • To run, launch command: ./gradlew :desktop:run
  • Or choose desktop configuration in IDE and run it.
    desktop-run-configuration.png

Building native desktop distribution

./gradlew :desktop:package
# outputs are written to desktop/build/compose/binaries

Running Android application

Open project in Intellij IDEA or Android Studio and run "android" configuration.

Running Web browser application

  • To run, launch command: ./gradlew :web:jsBrowserDevelopmentRun
  • Or choose browser configuration in IDE and run it.
    browser-run-configuration.png

Running iOS application

Open and build the Xcode project located in ios folder.

Desktop