PeopleInSpace/README.md

63 lines
3.8 KiB
Markdown
Raw Normal View History

2019-12-22 20:31:15 +00:00
# PeopleInSpace
2019-12-22 20:25:01 +00:00
2020-04-17 19:05:04 +00:00
Minimal **Kotlin Multiplatform** project using Jetpack Compose and SwiftUI. Currently running on
2020-11-17 16:58:10 +00:00
* Android (Jetpack Compose)
* iOS (SwiftUI)
* watchOS (SwiftUI)
* macOS (SwiftUI)
2020-12-02 20:36:46 +00:00
* Desktop (Compose for Desktop)
2020-11-17 16:58:10 +00:00
* Web (Kotlin/JS + React Wrapper)
2021-02-13 15:03:17 +00:00
* JVM (small Ktor back end service + `Main.kt` in `common` module)
2019-12-22 20:31:15 +00:00
It makes use of basic API (http://open-notify.org/Open-Notify-API/People-In-Space/) to show list of people currently in
space (inspired by https://kousenit.org/2019/12/19/a-few-astronomical-examples-in-kotlin/)! The list is shown on Android
2020-08-22 11:08:09 +00:00
using **Jetpack Compose**, on iOS using **SwiftUI** and on Web using Kotlin/JS React wrapper.
2019-12-22 20:25:01 +00:00
2020-11-17 16:58:10 +00:00
Related posts:
2020-05-02 14:33:18 +00:00
* [Minimal Kotlin Multiplatform project using Compose and SwiftUI](https://johnoreilly.dev/posts/minimal-kotlin-platform-compose-swiftui/)
* [Adding some Storage (to) Space](https://johnoreilly.dev/posts/adding-sqldelight-to-peopleinspace/)
* [Kotlin Multiplatform running on macOS](https://johnoreilly.dev/posts/kotlinmultiplatform-macos/)
* [PeopleInSpace hits the web with Kotlin/JS and React](https://johnoreilly.dev/posts/peopleinspace-kotlinjs/)
2020-05-16 22:19:52 +00:00
* [Using Koin in a Kotlin Multiplatform Project](https://johnoreilly.dev/posts/kotlinmultiplatform-koin/)
2020-11-17 16:58:10 +00:00
* [Jetpack Compose for the Desktop!](https://johnoreilly.dev/posts/jetpack-compose-desktop/)
2020-11-30 14:48:41 +00:00
* [Comparing use of LiveData and StateFlow in a Jetpack Compose project](https://johnoreilly.dev/posts/jetpack-compose-stateflow-livedata/)
2021-01-03 19:30:45 +00:00
* [Wrapping Kotlin Flow with Swift Combine Publisher in a Kotlin Multiplatform project](https://johnoreilly.dev/posts/kotlinmultiplatform-swift-combine_publisher-flow/)
2021-01-22 15:07:13 +00:00
* [Using Swift Packages in a Kotlin Multiplatform project](https://johnoreilly.dev/posts/kotlinmultiplatform-swift-package/)
2021-01-03 19:30:45 +00:00
2020-05-02 14:33:18 +00:00
2021-02-13 15:03:17 +00:00
Note that this repository very much errs on the side of minimalism to help more clearly illustrate key moving parts of a Koltin
2020-05-12 19:13:31 +00:00
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
2020-05-12 17:54:08 +00:00
beyond this then I'd definitely recommend checking out [KaMPKit](https://github.com/touchlab/KaMPKit)
2020-08-22 11:08:09 +00:00
### 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
2020-08-22 11:08:09 +00:00
iOS/watchOS/macOS projects remember to open `.xcworkspace` file (and not `.xcodeproj` one). To exercise web client run `./gradlew :web:browserDevelopmentRun`.
2019-12-22 21:34:15 +00:00
**UPDATE**: now also works in stable version of Android Studio.
2020-11-17 16:58:10 +00:00
### Jetpack Compose for Desktop client
2021-02-13 15:03:17 +00:00
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)
2019-12-22 21:34:15 +00:00
2021-02-27 12:06:30 +00:00
### Screenshots
2021-02-27 12:09:56 +00:00
<img width="546" alt="Screenshot 2021-02-27 at 12 09 02" src="https://user-images.githubusercontent.com/6302/109386736-ac1f0700-78f4-11eb-812e-4bf971a8c2a7.png">
2021-02-27 12:06:30 +00:00
2021-03-07 17:06:45 +00:00
<img width="555" alt="Screenshot 2021-03-07 at 17 03 46" src="https://user-images.githubusercontent.com/6302/110248059-2ab81c00-7f67-11eb-9b3a-2b04d1be43ef.png">
<img width="555" alt="Screenshot 2021-03-07 at 17 05 31" src="https://user-images.githubusercontent.com/6302/110248116-69e66d00-7f67-11eb-8942-ab18fb8e48ff.png">
2021-02-27 12:06:30 +00:00
2019-12-22 20:39:14 +00:00
### Languages, libraries and tools used
* [Kotlin](https://kotlinlang.org/)
* [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
2020-08-22 11:08:09 +00:00
* [Kotlinx Serialization](https://github.com/Kotlin/kotlinx.serialization)
2019-12-22 20:39:14 +00:00
* [Ktor client library](https://github.com/ktorio/ktor)
* [Android Architecture Components](https://developer.android.com/topic/libraries/architecture/index.html)
* [Koin](https://github.com/InsertKoinIO/koin)
* [Jetpack Compose](https://developer.android.com/jetpack/compose)
* [SwiftUI](https://developer.apple.com/documentation/swiftui)