PeopleInSpace/README.md

178 lines
4.6 KiB
Markdown
Raw Normal View History

2019-12-22 20:31:15 +00:00
# PeopleInSpace
2019-12-22 20:25:01 +00:00
2019-12-22 20:31:15 +00:00
Minimal **Kotlin Multiplatform** project using Jetpack Compose and SwiftUI
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
using **Jetpack Compose** and on iOS using **SwiftUI**
2019-12-22 20:25:01 +00:00
2019-12-22 20:39:14 +00:00
**Note**: You need to use Android Studio v4.0 (currently on Canary 6). Have tested on XCode v11.3
2019-12-22 20:25:01 +00:00
2019-12-22 21:34:15 +00:00
2019-12-23 13:53:01 +00:00
The following is pretty much all the code used (along with gradle files/resources etc). I did say it was *minimal*!!
2019-12-22 21:34:15 +00:00
2019-12-23 13:53:01 +00:00
### iOS SwiftUI Code
2019-12-22 21:34:15 +00:00
2019-12-22 21:42:24 +00:00
```swift
2019-12-22 21:34:15 +00:00
struct ContentView: View {
@ObservedObject var peopleInSpaceViewModel = PeopleInSpaceViewModel(repository: PeopleInSpaceRepository())
var body: some View {
NavigationView {
List(peopleInSpaceViewModel.people, id: \.name) { person in
PersonView(person: person)
}
.navigationBarTitle(Text("PeopleInSpace"), displayMode: .large)
.onAppear(perform: {
self.peopleInSpaceViewModel.fetch()
})
}
}
}
struct PersonView : View {
var person: Assignment
var body: some View {
HStack {
VStack(alignment: .leading) {
Text(person.name).font(.headline)
Text(person.craft).font(.subheadline)
}
}
}
```
2019-12-23 13:53:01 +00:00
### iOS Swift ViewModel
```swift
class PeopleInSpaceViewModel: ObservableObject {
@Published var people = [Assignment]()
private let repository: PeopleInSpaceRepository
init(repository: PeopleInSpaceRepository) {
self.repository = repository
}
func fetch() {
repository.fetchPeople(success: { data in
self.people = data
})
}
}
```
### Android Jetpack Compose code
2019-12-22 21:34:15 +00:00
2019-12-22 21:42:24 +00:00
```kotlin
2019-12-22 21:34:15 +00:00
class MainActivity : AppCompatActivity() {
private val peopleInSpaceViewModel: PeopleInSpaceViewModel by viewModel()
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContent {
mainLayout(peopleInSpaceViewModel)
}
}
}
@Composable
fun mainLayout(peopleInSpaceViewModel: PeopleInSpaceViewModel) {
MaterialTheme {
val people = +observe(peopleInSpaceViewModel.peopleInSpace)
Column {
people?.forEach { person ->
Row(person)
}
}
}
}
@Composable
fun Row(person: Assignment) {
Padding(16.dp) {
Text(text = "${person.name} (${person.craft})")
}
}
```
2019-12-23 13:53:01 +00:00
### Android Kotlin ViewModel
```kotlin
class PeopleInSpaceViewModel(peopleInSpaceRepository: PeopleInSpaceRepository) : ViewModel() {
val peopleInSpace = MutableLiveData<List<Assignment>>(emptyList())
init {
viewModelScope.launch(Dispatchers.IO) {
val people = peopleInSpaceRepository.fetchPeople()
peopleInSpace.postValue(people)
}
}
}
```
### Shared Kotlin Repository
```kotlin
class PeopleInSpaceRepository {
private val peopleInSpaceApi = PeopleInSpaceApi()
suspend fun fetchPeople() : List<Assignment> {
val result = peopleInSpaceApi.fetchPeople()
return result.people
}
fun fetchPeople(success: (List<Assignment>) -> Unit) {
GlobalScope.launch(ApplicationDispatcher) {
success(fetchPeople())
}
}
}
```
### Shared Kotlin API Client Code (using **Ktor** and **Kotlinx Serialization** library)
```kotlin
@Serializable
data class AstroResult(val message: String, val number: Int, val people: List<Assignment>)
@Serializable
data class Assignment(val craft: String, val name: String)
class PeopleInSpaceApi {
private val baseUrl = "http://api.open-notify.org/astros.json"
private val client by lazy {
HttpClient() {
install(JsonFeature) {
serializer = KotlinxSerializer(Json(JsonConfiguration(strictMode = false)))
}
}
}
suspend fun fetchPeople(): AstroResult {
return client.get("$baseUrl")
}
}
```
2019-12-22 21:34:15 +00:00
2019-12-22 20:39:14 +00:00
### Languages, libraries and tools used
* [Kotlin](https://kotlinlang.org/)
* [Kotlin Corooutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
* [Kotlin Serialization](https://github.com/Kotlin/kotlinx.serialization)
* [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)