PeopleInSpace/README.md
Saidu Ernest Kamara b8bba25ef4
Improved building documentation in README.md
Made building documentation more readable in README.md
2021-05-31 15:02:28 +02:00

4.9 KiB

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

Related posts:

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 Arctic Fox (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.

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

Screenshot 2021-02-27 at 12 09 02 Screenshot 2021-03-07 at 17 03 46 Screenshot 2021-03-07 at 17 05 31

Languages, libraries and tools used