This is a Kotlin Multiplatform project targeting Android, iOS, Web, Desktop (JVM).

• /composeApp is for code that will be shared across your Compose Multiplatform applications. It contains several subfolders:

  • commonMain is for code that’s common for all targets.
  • Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, the iosMain folder would be the right place for such calls. Similarly, if you want to edit the Desktop (JVM) specific part, the jvmMain folder is the appropriate location.

• /iosApp contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.

Build and Run Android Application

To build and run the development version of the Android app, use the run configuration from the run widget in your IDE’s toolbar or build it directly from the terminal:

• on macOS/Linux

  ./gradlew :composeApp:assembleDebug

• on Windows

  .\gradlew.bat :composeApp:assembleDebug

Build and Run Desktop (JVM) Application

To build and run the development version of the desktop app, use the run configuration from the run widget in your IDE’s toolbar or run it directly from the terminal:

• on macOS/Linux

  ./gradlew :composeApp:run

• on Windows

  .\gradlew.bat :composeApp:run

Build and Run Web Application

To build and run the development version of the web app, use the run configuration from the run widget in your IDE's toolbar or run it directly from the terminal:

• for the Wasm target (faster, modern browsers):
  • on macOS/Linux

    ./gradlew :composeApp:wasmJsBrowserDevelopmentRun

  • on Windows

    .\gradlew.bat :composeApp:wasmJsBrowserDevelopmentRun

• for the JS target (slower, supports older browsers):
  • on macOS/Linux

    ./gradlew :composeApp:jsBrowserDevelopmentRun

  • on Windows

    .\gradlew.bat :composeApp:jsBrowserDevelopmentRun

Build and Run iOS Application

To build and run the development version of the iOS app, use the run configuration from the run widget in your IDE’s toolbar or open the /iosApp directory in Xcode and run it from there.

GitHub Pages Preview

This project is configured to automatically deploy a web preview to GitHub Pages:

• Main branch: Deploys on every push to main.
• Pull Requests: Deploys a unique preview for every PR and posts a link in the PR comments.

To enable this:

1. Push your changes to GitHub.
2. Go to your repository settings on GitHub.
3. Navigate to Settings > Pages.
4. Under Build and deployment > Branch, ensure it is set to gh-pages and the folder is / (root).
5. Your main preview will be available at https://<your-username>.github.io/<your-repo-name>/.
6. For Pull Requests, look for a comment from "github-actions" with the preview link.

---

Learn more about Kotlin Multiplatform, Compose Multiplatform, Kotlin/Wasm…

We would appreciate your feedback on Compose/Web and Kotlin/Wasm in the public Slack channel #compose-web. If you face any issues, please report them on YouTrack.