wbrawner/PeopleInSpace

Fork 0

Minimal Kotlin Multiplatform project with SwiftUI, Jetpack Compose, Wear Compose, Compose for Desktop, Compose for Web and Kotlin/JS + React clients along with Ktor backend.

Find a file

John O'Reilly de0ca10db9 Update README.md		2021-05-21 19:29:45 +01:00
.github/workflows	kotlin/js gh-pages deploy updates	2021-02-05 14:19:48 +00:00
app	remove LiveData dependency	2021-05-01 15:15:14 +01:00
backend	further compose for web changes	2021-05-20 18:24:18 +01:00
buildSrc	further compose for web changes	2021-05-20 18:24:18 +01:00
common	further compose for web changes	2021-05-20 18:24:18 +01:00
compose-desktop	added platform-specific koin providers	2021-04-12 00:59:36 +05:30
compose-web	further compose for web changes	2021-05-20 18:24:18 +01:00
gradle/wrapper	Kotlin 1.4.31, Compose beta, koin 3.0.1-alpha	2021-03-02 21:39:06 +00:00
ios/PeopleInSpaceSwiftUI	SwiftUI: show iss position on map	2021-02-27 10:11:41 +00:00
macOS/PeopleInSpace	macOS map fix	2021-01-10 20:16:38 +00:00
watchos/PeopleInSpaceWatch	scope updates	2020-11-01 17:31:51 +00:00
web	further compose for web changes	2021-05-20 18:24:18 +01:00
.gitignore	Removed file that shouldn't be tracked	2020-09-06 16:19:54 +01:00
build.gradle.kts	further compose for web changes	2021-05-20 18:24:18 +01:00
gradle.properties	update to kotlin 1.4.10 + other dependency updates	2020-09-10 17:30:00 +01:00
gradlew	Update gradle to 6.5.1	2020-07-21 12:11:41 +02:00
gradlew.bat	Update gradle to 6.5.1	2020-07-21 12:11:41 +02:00
LICENSE	add Apache-2 license	2020-10-12 20:22:08 +01:00
README.md	Update README.md	2021-05-21 19:29:45 +01:00
settings.gradle.kts	Compose for Web wip	2021-05-10 16:24:01 +01:00

README.md

PeopleInSpace

Minimal Kotlin Multiplatform project using Compose and SwiftUI. Currently running on

Android (Jetpack Compose)
iOS (SwiftUI)
watchOS (SwiftUI)
macOS (SwiftUI)
Desktop (Compose for Desktop)
Web (Compose for Web)
Web (Kotlin/JS + React Wrapper)
JVM (small Ktor back end service + Main.kt in common module)

It makes use of Open Notify PeopleInSpace API to show list of people currently in space and also the position of the International Space Station (inspired by https://kousenit.org/2019/12/19/a-few-astronomical-examples-in-kotlin/)!

The project is included as sample in the official Kotlin Multiplatform Mobile docs and also the Google Dev Library

Note that this repository very much errs on the side of minimalism to help more clearly illustrate key moving parts of a Kotlin Multiplatform project and also to hopefully help someone just starting to explore KMP to get up and running for first time (and is of course primarily focussed on use of Jetpack Compose and SwiftUI). If you're at stage of moving beyond this then I'd definitely recommend checking out KaMPKit from Touchlab. I also have the following samples that demonstrate the use of a variety of Kotlin Multiplatform libraries (and also use Jetpack Compose and SwiftUI).

Building

You need to use Android Studio Canary version (note: Java 11 is now the minimum version required). Have tested with XCode v11 and v12. When opening iOS/watchOS/macOS projects remember to open .xcworkspace file (and not .xcodeproj one). To exercise (React based) web client run ./gradlew :web:browserDevelopmentRun. To run backend you can either run ./gradlew :backend:run or run Server.kt directly from Android Studio. After doing that you should then for example be able to open http://localhost:9090/astros_local.json in a browser.

UPDATE: now also works in stable version of Android Studio.

Compose for Web client

The Compose for Web client resides in the compose-web module and can be run by invoking ./gradlew :compose-web:jsBrowserDevelopmentRun

Compose for Desktop client

This client is available in compose-desktop module. Note that you need to use appropriate version of JVM when running (works for example with Java 11)

Screenshots