Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/badoo/MVIKotlin
Extendable MVI framework for Kotlin Multiplatform with powerful debugging tools (logging and time travel), inspired by Badoo MVICore library
https://github.com/badoo/MVIKotlin
android framework hacktoberfest ios jvm kotlin kotlin-multiplatform multiplatform mvi native
Last synced: about 2 months ago
JSON representation
Extendable MVI framework for Kotlin Multiplatform with powerful debugging tools (logging and time travel), inspired by Badoo MVICore library
- Host: GitHub
- URL: https://github.com/badoo/MVIKotlin
- Owner: badoo
- License: apache-2.0
- Created: 2018-06-02T23:07:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-12-22T18:30:27.000Z (over 2 years ago)
- Last Synced: 2024-06-28T03:37:55.582Z (3 months ago)
- Topics: android, framework, hacktoberfest, ios, jvm, kotlin, kotlin-multiplatform, multiplatform, mvi, native
- Language: Kotlin
- Homepage: https://arkivanov.github.io/MVIKotlin
- Size: 4.79 MB
- Stars: 821
- Watchers: 19
- Forks: 66
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://search.maven.org/artifact/com.arkivanov.mvikotlin/mvikotlin)
[](https://github.com/arkivanov/MVIKotlin/blob/master/LICENSE)
[](https://kotlinlang.slack.com/archives/C01403U1ZGW)
## Maintenance notice
**This repository is not maintained. [Arkadii Ivanov](https://github.com/arkivanov) continued to work on the fork [arkivanov/MVIKotlin](https://github.com/arkivanov/MVIKotlin).**
## Inspiration
This project is inspired by [Badoo MVICore](https://github.com/badoo/MVICore) library.
## Overview
Should you have any questions or ideas please welcome to the Slack channel: [#mvikotlin](https://kotlinlang.slack.com/archives/C01403U1ZGW)
### What is MVI
MVI stands for Model-View-Intent. It is an architectural pattern that utilizes unidirectional data flow. The data circulates between `Model` and `View` only in one direction - from `Model` to `View` and from `View` to `Model`.
### What is MVIKotlin
MVIKotlin is a Kotlin Multiplatform framework that provides a way of (not only) writing
shared code using MVI pattern. It also includes powerful debug tools like
logging and time travel. The main functionality of the framework does not depend on any
reactive nor coroutines library. Extensions for [Reaktive](https://github.com/badoo/Reaktive)
and for [Coroutines](https://github.com/Kotlin/kotlinx.coroutines) libraries are
provided as separate modules.
#### Responsibility
MVIKotlin does not bring or enforce any particular architecture. Its responsibility can be described as follows:
- To provide a single source of truth for `State` (the scope is not defined, it can be a whole app, a screen, a feature, or a part of a feature);
- To provide an abstraction for UI with efficient updates (however this is not obligatory, you can use whatever you want);
- To provide lifecycle aware connections (binding) between inputs and outputs (again this is not obligatory in any way).
Everything else is out of scope of the library, there are no definitions for "screens", "features", "modules", etc. Also, no particular reactive framework is enforced/exposed. This gives a lot of flexibility:
- MVIKotlin can be introduced incrementally (e.g. you can start using it in a small feature and then expand gradually);
- You can use/experiment with different architectures, approaches and/or libraries for navigation, UI, modularization, etc;
- Use whatever reactive framework you like or don't use it at all.
You can find one of the architecture options in the [samples](https://github.com/arkivanov/MVIKotlin/tree/master/sample). Again, this is just an example of one possible solution.
## Setup
Recommended minimum Gradle version is 5.3. Please read first the documentation about
[metadata publishing mode](https://kotlinlang.org/docs/reference/building-mpp-with-gradle.html#experimental-metadata-publishing-mode).
There are a number of modules published to Maven Central:
- `mvikotlin` - core interfaces and functionality (multiplatform)
- `mvikotlin-main` - the main module with the default `Store` implementation (mutiplatform)
- `mvikotlin-logging` - logging functionality (mutiplatform)
- `mvikotlin-timetravel` - time travel feature (mutiplatform)
- `mvikotlin-extensions-reaktive` - extensions set for Reaktive library (multiplatform)
- `mvikotlin-extensions-coroutines` - extensions set for coroutines (multiplatform)
- ~~`keepers` - provides `StateKeeper` and `InstanceKeeper` API for state preservation and objects retaining~~ (deprecated)
- `rx` - a tiny module with abstractions over rx and coroutines (multiplatform)
Add required modules to your module`s build.gradle file:
```groovy
implementation "com.arkivanov.mvikotlin::"
```
### IDEA Live Templates
To speed up the creation of new Stores, you can use the following [IDEA Live Templates](https://gist.github.com/arkivanov/34bb84e73e56c22a4e7c752421d5f02c).
## Features
* Multiplatform: Android, JVM, JavaScript, iosX64, iosArm64, macosX64, linuxX64
* Does not depend on any reactive library or coroutines
* Extensions for [Reaktive](https://github.com/badoo/Reaktive) library
* Extensions for [Coroutines](https://github.com/Kotlin/kotlinx.coroutines)
* Multithreading friendly (freezable in Kotlin Native if needed)
* Lifecycle-aware connections (bindins) between inputs and outputs
* Logging functionality with customizable logger and formatter
* Time travel feature:
* Multiplatform for all supported targets
* Plug-and-play UI for Android
* Plug-and-play UI for iOS (copy-paste from the sample app)
* Export/import events for Android
* IntelliJ IDEA and Android Studio [plugin](https://plugins.jetbrains.com/plugin/14241-mvikotlin-time-travel) for Android apps
* Desktop [client application](mvikotlin-timetravel-client/app-desktop) for Android, Java and native Apple (iOS, watchOS, tvOS, macOS) apps
## Documentation
[https://arkivanov.github.io/MVIKotlin](https://arkivanov.github.io/MVIKotlin)
## Sample project
The sample project is a todo list with details view.
* Shared module using Reaktive is [here](sample/todo-reaktive)
* Shared module using coroutines is [here](sample/todo-coroutines)
* Sample Android application with both Reaktive and coroutines implementations, plus logging and time travel is [here](sample/todo-app-android)
* Sample iOS application with Reaktive implementation only, plus logging and time travel is [here](sample/todo-app-ios)
* Sample JavaScript application with both Reaktive and coroutines implementations, plus logging and time travel is [here](sample/todo-app-js)
## Author
Twitter: [@arkann1985](https://twitter.com/arkann1985)
If you like this project you can always 
;-)
## Watch video (time travel, logs, debug, etc.)
#### Debugging Android application with MVIKotlin
[](https://youtu.be/_bbxR503-u0)
#### Debugging iOS application with MVIKotlin
[](https://youtu.be/MJCYQzeL-w8)
#### Debugging Android application with IntelliJ IDEA time travel plugin
[](https://youtu.be/Tr2ayOcVU34)
#### Debugging iOS application using MVIKotlin time travel client app
[](https://youtu.be/rj6GwA2ZQkk)