https://github.com/guilhe/expressus

Kotlin Multiplatform Coffee Machine
https://github.com/guilhe/expressus

android compose compose-multiplatform finite-state-machine ios jetpack-compose kotlin kotlin-multiplatform kotlin-multiplatform-mobile model-view-intent swift swiftui ui-state-management

Last synced: 1 day ago
JSON representation

Kotlin Multiplatform Coffee Machine

• Host: GitHub
• URL: https://github.com/guilhe/expressus
• Owner: GuilhE
• License: apache-2.0
• Created: 2022-04-19T14:12:38.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-20T21:56:19.000Z (2 months ago)
• Last Synced: 2024-10-21T02:16:11.581Z (2 months ago)
• Topics: android, compose, compose-multiplatform, finite-state-machine, ios, jetpack-compose, kotlin, kotlin-multiplatform, kotlin-multiplatform-mobile, model-view-intent, swift, swiftui, ui-state-management
• Language: Kotlin
• Homepage:
• Size: 13.4 MB
• Stars: 110
• Watchers: 1
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Expressus

[![Featured in Kotlin Weekly - Issue #299](https://img.shields.io/badge/Featured_in_Kotlin_Weekly-Issue_%23299-7878b4)](https://mailchi.mp/kotlinweekly/kotlin-weekly-299) [![Featured in Kotlin Weekly - Issue #301](https://img.shields.io/badge/Featured_in_Kotlin_Weekly-Issue_%23301-7878b4)](https://mailchi.mp/kotlinweekly/kotlin-weekly-301) [![Android Weekly](https://androidweekly.net/issues/issue-515/badge)](https://androidweekly.net/issues/issue-515) [![Android Weekly](https://androidweekly.net/issues/issue-583/badge)](https://androidweekly.net/issues/issue-583) 

KMP sample project acting as a playground to illustrate what's discussed in these articles:



 

 

 



## Details

### Modules

#### Shared

- Model-View-Intent architecture

- Finite State Machine to validate state transitions

- State restoration (both for UI State and FSM State)

#### Shared Ui Compose

- Compose Multiplatform to share composables between Desktop, Android and iOS

### Platforms

#### Mobile

- UI State emissions using Kotlin Flow and Swift Combine Publisher

- Jetpack Compose, Compose Multiplatform and SwiftUI

`./gradlew :androidApp:installDebug`

To run iosApp open `iosApp/Expressus.xcworkspace` in Xcode.

>[!NOTE]

> Due to this [issue](https://github.com/JetBrains/compose-multiplatform/issues/4720#issuecomment-2100898893) you must first run the following steps:

> 1. run `./gradlew clean`

> 2. run build project in Xcode

> 3. run `./gradlew generateDummyFramework`

> 4. `cd ./iosApp` and run `pod install`

> 5. run standard configuration.

#### Desktop

- UI State emissions using Kotlin Flow

- Compose Multiplatform

`./gradlew :desktopApp:run`

## Outputs

### UI



    

    

    

    



### FSM + MVI



      



Click on each image for full resolution


## LICENSE

Copyright (c) 2022-present GuilhE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy

of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under

the License.