wojta / hello-kotlin-multiplatform

Multiplatform Kotlin Hello World (Android/Java/JavaScript)

KOTLIN 1.7.20

Multiplatform Kotlin Hello World

This project demonstrates sharing runtime independent code between different Kotlin's runtimes (Java/Android/JavaScript). It uses Gradle build engine.

It uses new support for multiplatform modules with plugin kotlin-multiplatform.

• Kotlin multiplatform overview

This example uses now Kotlin Multiplatform as is in Kotlin 1.7.20.

Deprecated implementations

Older implementation with kotlin-multiplatform plugin and various hacks was moved to old-kotlin-1.2 branch.

More older implementation that didn't use kotlin-multiplatform plugin and various hacks was moved to old-multiplatform branch.

Oldest implementation that used various hacks was moved to old-multiplatform branch.

What is Kotlin?

Kotlin is a programming language developed by Jetbrains. It's fully compatibile with Java runtimes and also there is support for JavaScript transpilation. Experimental version of Kotlin/Native has goal to also build fully native apps for iOS, Linux, Windows and possibly other platforms.

What is it doing?

• writes Hello Kotlin!
• calculates first 1000 prime numbers (this part is shared between runtimes) and prints them

Structure

It's the Gradle multiple modules project.

• hello_android_app - Android application module, it's compiled to DEX bytecode, it produces APK file upon build
• hello_js_browser_app - application transpiled for frontend JavaScript, packed in WebPack, it's only statically served by Node.js
• hello_js_node_app - console application transpiled to Node.js JavaScript
• hello_jvm_app - console application compiled to Java bytecode for JVM, produces JAR that can be executed by eg. Oracle JVM
• hello_shared - multiplatform library project, with shared and platform specific code
  • commonMain - shared Kotlin source code, platform independent code
  • commonTest - shared tests, platform independent tests
  • jsMain - JavaScript runtimes platform dependent code
  • jsTest - JavaScript runtimes specific tests
  • jvmMain - Java runtime platform dependent code
  • jvmTest - Java runtime specific tests
  • androidMain - Android runtime platform dependent code
  • androidTest - Android runtime specific tests

Modules dependency

Platform implementation specifics

• prime number calculation is platform independent, single code shared for all platforms
• text output on screen is platform dependent
  • Android - it's done by adding with TextView to layout
  • Frontend JavaScript - it adds element in DOM of HTML page
  • Node.js JavaScript - uses console.log()
  • JVM - uses System.out.println()

Note: Ordinary console output can be done by println() function from Kotlin Standard Library.

Implementation in modules

Building and running the demo

It was checked only under Linux Mint, probably there won't be any problems with most Unix-like environments.

Android application

You can use Android Studio to run the application. To build from command line, you can use

# ./gradlew hello_android_app:build

and APK file is located in your build/outputs/apk directory.

JVM console application

# ./gradlew hello_jvm_app:build

You can than run the JAR file using java -jar hello_jvm_app.jar command from build/libs directory.

Frontend JavaScript application

# ./gradlew hello_js_browser_app:build

Webpack allows to host site directly from Gradle by

# ./gradlew hello_js_browser_app:run 

It will run locally on http://localhost:8088/.

Node.js console application

# ./gradlew hello_js_node_app:build

You can execute it in hello_js_node_app/build/productionLibrary directory by executing:

# node .

to see all build options

# ./gradlew tasks --all

License

Do whathever you want with this.

hello-kotlin-multiplatform's Issues

Native console app

Add native console app that compiles for Linux, MacOS or Windows.

Use new Multiplatform gradle plugin and Kotlin 1.3

There is new multiplatform support for Kotlin. Use Kotlin 1.3

https://kotlinlang.org/docs/reference/multiplatform.html

So it's needed to change the project to support this.

No test classes are found for common and js projects on 'gradle test'

Tests fail to run in hello_lib_common and hello_js_browser_app.
JVM project tests seem to run correctly.

gradle test --info
...
> Task :hello_lib_common:testClasses UP-TO-DATE
Skipping task ':hello_lib_common:testClasses' as it has no actions.
:hello_lib_common:testClasses (Thread[Task worker for ':',5,main]) completed. Took 0.0 secs.
:hello_lib_common:test (Thread[Task worker for ':',5,main]) started.
...
> Task :hello_lib_jvm:testClasses UP-TO-DATE
Skipping task ':hello_lib_jvm:testClasses' as it has no actions.
:hello_lib_jvm:testClasses (Thread[Daemon worker Thread 9,5,main]) completed. Took 0.0 secs.
:hello_lib_jvm:test (Thread[Daemon worker Thread 9,5,main]) started.

Apologies for not showing this more convincingly, or succinctly, but gradle limits my options since it does not print out test results. (Or I don't know how to configure it to in a nice way).

kotlin-platform-android

In Android app use new Kotlin feature with plugin kotlin-platform-android.

CircleCI

Automatic building and testing using CircleCI.

IOS App

When can we expect a sample app for IOS mobile app (hello world) with Xcode? It is difficult to find examples on the internet.

hello_shared module is not working with autocomplete in Android Studio/IntelliJ

Problem is with lack of provided configuration in default java plugin, it's done by hack from there http://www.sinking.in/blog/provided-scope-in-gradle/

configurations {
    provided
}

sourceSets {
    main {
        compileClasspath += configurations.provided
        runtimeClasspath += configurations.provided
    }
}

dependencies {
    provided "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
}

Rewrite Android app to Compose

Use Compose and prepare it for Multiplatform Compose.

Use version catalog

• upgrade Gradle
• Add version catalog and proper project typesafe referencing

Upgrade to Kotlin 1.8.20

Upgrade multiplatform example to the latest Kotlin version.