Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/badoo/MVICore
MVI framework with events, time-travel, and more
https://github.com/badoo/MVICore
android android-architecture android-library kotlin-android mvi mvi-architecture
Last synced: 13 days ago
JSON representation
MVI framework with events, time-travel, and more
- Host: GitHub
- URL: https://github.com/badoo/MVICore
- Owner: badoo
- License: other
- Created: 2018-03-12T21:50:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-15T20:11:28.000Z (about 2 months ago)
- Last Synced: 2024-10-21T11:23:11.198Z (19 days ago)
- Topics: android, android-architecture, android-library, kotlin-android, mvi, mvi-architecture
- Language: Kotlin
- Homepage: https://badoo.github.io/MVICore/
- Size: 5.11 MB
- Stars: 1,267
- Watchers: 38
- Forks: 90
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin - MVICore - MVI framework with events, time-travel, and more (Libraries)
README
# MVICore
[](https://github.com/badoo/MVICore/actions/workflows/build.yml)
[](https://jitpack.io/#badoo/mvicore)
[](http://www.apache.org/licenses/LICENSE-2.0)
## What's this?
MVICore is a modern, Kotlin-based MVI framework:
- **Scaling with complexity**: operate with a single Reducer if needed, with the option of having the full power of additional components to handle more complex cases
- **Event handling**: A solution to handling events that you don’t want to store in the state
- **Reactive component binding**: A super simple API to bind your reactive endpoints to each other with automatic lifecycle handling
- **Custom Middlewares**: for every single component in the system, with flexible configuration options
- **Logger**: An out-of-the-box logger Middleware
- **Time Travel Debugger**: for ALL of your reactive components (not just your state machine!) with UI controls for recording and playback
## Documentation
The library comes with lots of powerful capabilities and tooling.
See [https://badoo.github.io/MVICore/](https://badoo.github.io/MVICore) for full documentation.
## Download
Available through jitpack.
Add the maven repo to your root `build.gradle`
```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
Add the dependencies:
- Framework:
```groovy
implementation 'com.github.badoo.mvicore:mvicore:{latest-version}'
```
- Binder (for versions higher than 1.2.4)
```groovy
implementation 'com.github.badoo.mvicore:binder:{latest-version}'
```
- Helper classes for Android:
```groovy
implementation 'com.github.badoo.mvicore:mvicore-android:{latest-version}'
```
- ModelWatcher for efficient view updates
```groovy
implementation 'com.github.badoo.mvicore:mvicore-diff:{latest-version}'
```
- Time Travel Debugger controls in a [DebugDrawer](https://github.com/palaima/DebugDrawer) module (You need to add the dependencies to DebugDrawer and configure it yourself before you can use this):
```groovy
implementation 'com.github.badoo.mvicore:mvicore-debugdrawer:{latest-version}'
```
## Related articles & videos
- [MVI beyond state reducers](https://medium.com/bumble-tech/a-modern-kotlin-based-mvi-architecture-9924e08efab1)
- [Building a system of reactive components with Kotlin](https://medium.com/bumble-tech/building-a-system-of-reactive-components-with-kotlin-ff56981e92cf)
- [Unidirectional data-flow and the Zen of black box components](https://medium.com/bumble-tech/unidirectional-data-flow-and-the-zen-of-black-box-components-fff5d618f8b6)
- [Time Travel Debug Everything!](https://medium.com/bumble-tech/time-travel-debug-everything-droidconuk-2018-lightning-talk-445217258401)