Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhimuktheeswarar/flywheel
A simple and predictable state management library inspired by Redux for Kotlin Multiplatform using the concepts of actors.
https://github.com/abhimuktheeswarar/flywheel
android concurrency coroutines elm-architecture flux flux-architecture kotlin kotlin-multiplatform mvi mvi-android mvi-architecture redux redux-actions redux-store state-management unidirectional-data-flow
Last synced: about 1 month ago
JSON representation
A simple and predictable state management library inspired by Redux for Kotlin Multiplatform using the concepts of actors.
- Host: GitHub
- URL: https://github.com/abhimuktheeswarar/flywheel
- Owner: abhimuktheeswarar
- License: apache-2.0
- Created: 2021-06-26T18:35:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T09:31:25.000Z (almost 2 years ago)
- Last Synced: 2024-12-16T03:50:07.389Z (about 1 month ago)
- Topics: android, concurrency, coroutines, elm-architecture, flux, flux-architecture, kotlin, kotlin-multiplatform, mvi, mvi-android, mvi-architecture, redux, redux-actions, redux-store, state-management, unidirectional-data-flow
- Language: Objective-C
- Homepage:
- Size: 47.5 MB
- Stars: 43
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **Flywheel**
[](https://search.maven.org/search?q=com.msabhi.flywheel)
[](http://www.apache.org/licenses/LICENSE-2.0)
[](http://kotlinlang.org)
A simple and predictable state management library inspired by [Flux](https://facebook.github.io/flux/docs/in-depth-overview) + [Elm](https://guide.elm-lang.org/architecture/) + [Redux](https://github.com/reactjs/redux). Flywheel is built on top of [Corotuines](https://kotlinlang.org/docs/coroutines-overview.html) using the concepts of [structured concurrency](https://kotlinlang.org/docs/coroutines-basics.html#structured-concurrency). At the core, lies the [State Machine](https://en.wikipedia.org/wiki/Finite-state_machine) which is based on [actor model](https://en.wikipedia.org/wiki/Actor_model).
## **Why Flywheel?**
The goal was to make the state management concept of Redux simple, understandable & easy to use in Kotlin based projects. To achieve that, we adapted only the core concepts from Redux and slightly modified them. We excluded Android, Apple or any platform-specific dependencies. It is just pure Kotlin. By doing so, you are free to choose your architecture that best suits your codebase, no need to make any big refactor to fit in Flywheel. Don't be fooled by its simplicity, Flywheel got you covered for all practical use-cases. Even if we missed anything, it can be easily extended to support your use cases.
## **Getting started**
#### In Kotlin Multiplatfrom project:
```Kotlin
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("com.msabhi:flywheel:1.1.5-RC")
}
}
}
}
```
#### In Android / Gradle project:
```Kotlin
dependencies {
implementation("com.msabhi:flywheel-android:1.1.5-RC")
}
```
#### In Apple platforms
[](https://swiftpackageindex.com/abhimuktheeswarar/Flywheel)
[](https://swiftpackageindex.com/abhimuktheeswarar/Flywheel)
You can use the [Swift Package Manager](https://swift.org/package-manager) to install `Flywheel` by adding the proper description to your `Package.swift` file:
```swift
// swift-tools-version:5.3
import PackageDescription
let package = Package(
name: "YOUR_PROJECT_NAME",
dependencies: [
.package(url: "https://github.com/abhimuktheeswarar/Flywheel.git", from: "1.1.5-RC"),
]
)
```
Then run `swift build` whenever you get prepared.
## **Usage**
This is how a simple counter example looks like.
1. Define a state.
```Kotlin
data class CounterState(val counter: Int = 0) : State
```
2. Define actions that can change the state.
```Kotlin
sealed interface CounterAction : Action {
object IncrementAction : CounterAction
object DecrementAction : CounterAction
}
```
3. Define a reducer that updates the state based on the action & current state.
```Kotlin
val reduce = reducerForAction { action, state ->
with(state) {
when (action) {
is CounterAction.IncrementAction -> copy(counter = counter + 1)
is CounterAction.DecrementAction -> copy(counter = counter - 1)
}
}
}
```
4. Create a StateReserve.
```Kotlin
val stateReserve = StateReserve(
initialState = InitialState.set(CounterState()),
reduce = reduce)
```
5. Listen for state changes
```Kotlin
stateReserve.states.collect { state -> println(state.counter) }
```
6. Send actions to StateReserve to update the state.
```Kotlin
stateReserve.dispatch(IncrementAction)
```
### To learn more about Flywheel, head on over to our [wiki](https://github.com/abhimuktheeswarar/Flywheel/wiki).
## **License**
```License
Copyright (C) 2021 Abhi Muktheeswarar
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
http://www.apache.org/licenses/LICENSE-2.0
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.
```