multiplatform-hello - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #go #rust #deep-learning #linux #nodejs #windows #awesome #awesome-list #ios #open-source

multiplatform-hello

(★ 107)

Full-stack Hello World for Kotlin Multiplatform

File Explorer

Download Latest Version (.zip)

- - build.yml
- build.gradle.kts
- build.gradle.kts
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
- - ContentView.swift
  - Multiplatform_HelloApp.swift
- - project.pbxproj
- - Multiplatform_HelloTests.swift
- - Multiplatform_HelloUITests.swift
  - Multiplatform_HelloUITestsLaunchTests.swift
- yarn.lock
- build.gradle.kts
- build.gradle.kts
- build.gradle.kts
.gitignore
build.gradle.kts
gradle.properties
gradlew
gradlew.bat
LICENSE.txt
README.md
settings.gradle.kts

# Installation Guide

1. Get the code

git clone https://github.com/russhwolf/multiplatform-hello

Downloads the entire project code from GitHub to your computer.

cd multiplatform-hello

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

cd android

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Multiplatform Hello

A full-stack hello world for Kotlin Multiplatform

## Project Structure

This project consists of several gradle modules as well as an xcode project. It was developed using Intellij IDEA but is probably usable from Android Studio as well.

### Shared

This is the central module which is included in both server and client. It consists of a `Message` class which is serializable by `kotlinx-serialization`.

### Server

This is a simple Ktor server running on the Netty engine with a single endpoint `/message`, which outputs a `Message` object serialized to JSON.

Running `./gradlew server:run` will deploy the server to localhost on port 8080.

### Shared-Client

This consumes the `shared` module and contains shared client code. It includes an `ApiClient` class with a method to query the `/message` endpoint using the Ktor http client, as well as a top-level function `hello()` which provides a callback interface and rudimentary error-handling.

### Android

This is an Android project consuming the `:shared-mobile` module. It contains a single activity which calls the `hello()` function and displays its output in UI.

The Android app can be built by creating and running an Android run configuration in IDEA.

Because the server deploys to localhost, it's recommended to only run the app through the emulator. There is configuration to ensure that the emulator sees the local server deploy which will not work on-device.

### iOS

The iOS code lives in the `ios` directory. It includes a ViewController which calls the `hello()` function and renders its output to screen.

The iOS code can be modified or built by opening `ios/Multiplatform Hello.xcodeproj` in Xcode.

Because the server deploys to localhost, it's recommended to only run the app through the simulator, but there is gradle configuration for device targets as well.

### Browser

There is a browser client available in the `:browser` module. It contains a simple page which calls `hello()` and updates the page body with the output.

The browser client can be deployed with `./gradlew browser:browserRun`. It will deploy to localhost on port 8081 to avoid interfering with the server on 8080.

### Tests

Unit tests exist for the `:shared`, `:shared-client`, and `:server` modules. They can be run using the gradle task `check`. You may need to `clean` as well in order to re-run tests if no code-changes have happened.