Skip to content

Commit

Permalink
Update TodoApp example readme with Web app (JetBrains#796)
Browse files Browse the repository at this point in the history
  • Loading branch information
arkivanov authored Jun 18, 2021
1 parent fac8a85 commit ba7c429
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions examples/todoapp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ An example of Kotlin Multiplatform todo app with shared Android/Desktop Compose

This example supports the following targets:
- `Android` (Compose)
- `JVM` (Compose)
- `Desktop/JVM` (Compose)
- `Web/JavaScript` (Compose)
- `iOS` (SwiftUI, not Compose)

Libraries used:
Expand All @@ -18,9 +19,10 @@ There are multiple modules:
- `: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 `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.
Expand All @@ -29,7 +31,7 @@ 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 and Desktop, SwiftUI (not Compose) for iOS
- Pluggable UI - Compose UI for Android, Desktop and Web, SwiftUI (not Compose) for iOS

### Running desktop application
```
Expand All @@ -46,6 +48,11 @@ Features:

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

### Running Web browser application
```
./gradlew :web:jsBrowserDevelopmentRun
```

### Running iOS application

Open and build the Xcode project located in `ios` folder.
Expand Down
Binary file modified examples/todoapp/screenshots/todo.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ba7c429

Please sign in to comment.