uniflow-kt / uniflow-kt

Uniflow 🦄 - Simple Unidirectional Data Flow for Android & Kotlin, using Kotlin coroutines and open to functional programming

Setup 🚀

Current Version - 1.1.2

Gradle setup

Repository is now Maven Central:

repositories {
    mavenCentral()
}

Check the latest version

// Core
implementation 'org.uniflow-kt:uniflow-core:$uniflow_version'
testImplementation 'org.uniflow-kt:uniflow-test:$uniflow_version'

// Android
implementation 'org.uniflow-kt:uniflow-android:$uniflow_version'
testImplementation 'org.uniflow-kt:uniflow-android-test:$uniflow_version'

// Extras
implementation 'org.uniflow-kt:uniflow-saferesult:$uniflow_version'
implementation 'org.uniflow-kt:uniflow-arrow:$uniflow_version'

⚠️ Due to Maven Central migration, group id has been updated from io.uniflow to org.uniflow-kt ⚠️

Getting started 🚀

• Quick start with Uniflow

Documentation 📖

• What is Uniflow?
• Writing an Action to update your state
• Pushing Events for side effects
• Running coroutines from your Action
• State Guard - Running an action on a given state
• Notifying State Changes
• Easy Error Handling
• Logging Actions
• Testing your DataFlow
• States and Jetpack Compose
• From Coroutines Flow to Actions
• Defining Multiple Streams
• Persistent Stream to recover state
• More Safely with Functional Approach
• Migrating from Uniflow 0.x to 1.0.x

Sample Apps 🎉

• Weather App
• Jetpack Compose Samples with Uniflow

Resources ☕️

• Riding the state flow (AndroidMakers 2020)
• Making Android unidirectional data flow with Kotlin coroutines 🦄
• An efficient way to use Uniflow

Contact us 💬

Come talk on Kotlin Slack @ #uniflow channel