Browse Source

Update TodoApp example readme with Web app (#796)

pull/798/head
Arkadii Ivanov 3 years ago committed by GitHub
parent
commit
ba7c4293aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 13
      examples/todoapp/README.md
  2. BIN
      examples/todoapp/screenshots/todo.png

13
examples/todoapp/README.md

@ -2,7 +2,8 @@ An example of Kotlin Multiplatform todo app with shared Android/Desktop Compose
This example supports the following targets: This example supports the following targets:
- `Android` (Compose) - `Android` (Compose)
- `JVM` (Compose) - `Desktop/JVM` (Compose)
- `Web/JavaScript` (Compose)
- `iOS` (SwiftUI, not Compose) - `iOS` (SwiftUI, not Compose)
Libraries used: Libraries used:
@ -18,9 +19,10 @@ There are multiple modules:
- `:common:main` - displays a list of todo items and a text field - `:common:main` - displays a list of todo items and a text field
- `:common:edit` - accepts an item id and allows editing - `:common:edit` - accepts an item id and allows editing
- `:common:root` - navigates between `main` and `edit` screens - `:common:root` - navigates between `main` and `edit` screens
- `:common:compose-ui` - Shared Compose UI for `main` and `edit` screens - `:common:compose-ui` - Shared Compose UI for Android and Desktop
- `:android` - Android application - `:android` - Android application
- `:desktop` - Desktop application - `:desktop` - Desktop application
- `:web` - Web browser application + Compose Web UI
- `ios` - iOS Xcode project - `ios` - iOS Xcode project
The root module is integrated into Android, Desktop and iOS (non-Compose) apps. The root module is integrated into Android, Desktop and iOS (non-Compose) apps.
@ -29,7 +31,7 @@ Features:
- 99% of the code is shared: data, business logic, presentation, navigation and UI - 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. - View state is preserved when navigating between screens, Android configuration change, etc.
- Model-View-Intent (aka MVI) architectural pattern - Model-View-Intent (aka MVI) architectural pattern
- Pluggable UI - Compose UI for Android and Desktop, SwiftUI (not Compose) for iOS - Pluggable UI - Compose UI for Android, Desktop and Web, SwiftUI (not Compose) for iOS
### Running desktop application ### Running desktop application
``` ```
@ -46,6 +48,11 @@ Features:
Open project in Intellij IDEA or Android Studio and run "android" configuration. Open project in Intellij IDEA or Android Studio and run "android" configuration.
### Running Web browser application
```
./gradlew :web:jsBrowserDevelopmentRun
```
### Running iOS application ### Running iOS application
Open and build the Xcode project located in `ios` folder. Open and build the Xcode project located in `ios` folder.

BIN
examples/todoapp/screenshots/todo.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 204 KiB

Loading…
Cancel
Save