Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arkivanov/MVIKotlin

Extendable MVI framework for Kotlin Multiplatform with powerful debugging tools (logging and time travel)
https://github.com/arkivanov/MVIKotlin

Last synced: 5 days ago
JSON representation

Extendable MVI framework for Kotlin Multiplatform with powerful debugging tools (logging and time travel)

Host: GitHub
URL: https://github.com/arkivanov/MVIKotlin
Owner: arkivanov
License: apache-2.0
Created: 2021-12-10T14:53:46.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2024-09-08T08:54:18.000Z (2 months ago)
Last Synced: 2024-09-08T09:59:12.082Z (2 months ago)
Language: Kotlin
Homepage: https://arkivanov.github.io/MVIKotlin
Size: 5.61 MB
Stars: 809
Watchers: 20
Forks: 32
Open Issues: 3
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-kotlin-multiplatform - MVIKotlin - MVI framework for Kotlin Multiplatform. (Libraries / Architecture)
awesome-list - arkivanov/MVIKotlin - Extendable MVI framework for Kotlin Multiplatform with powerful debugging tools (logging and time travel) (Kotlin)
kmp-awesome - MVI Kotlin - MVI framework (Libraries / 🏗 Architecture)
awesome-kotlin-multiplatform - MVI Kotlin - Extendable MVI framework for Kotlin Multiplatform. (Architecture / SQL)

README

        

[![Maven Central](https://img.shields.io/maven-central/v/com.arkivanov.mvikotlin/mvikotlin?color=blue)](https://search.maven.org/artifact/com.arkivanov.mvikotlin/mvikotlin)

[![License](https://img.shields.io/badge/License-Apache/2.0-blue.svg)](https://github.com/arkivanov/MVIKotlin/blob/master/LICENSE)

[![kotlinlang|MVIKotlin](https://img.shields.io/badge/kotlinlang-mvikotlin-blue?logo=slack)](https://kotlinlang.slack.com/archives/C01403U1ZGW)

Should you have any questions or ideas - there is [Discussions](https://github.com/arkivanov/MVIKotlin/discussions) section. Also welcome to the Kotlin Slack channel - [#mvikotlin](https://kotlinlang.slack.com/archives/C01403U1ZGW)!

## ⚡⚡⚡ Where are all the stars, issues, discussions, pull requests, etc?

Having spent 5 years working on a variety of projects for Badoo/Bumble, I’m now off to another adventure. As part of that transition I was asked to transfer this repository to [Badoo GitHub account](https://github.com/badoo).

Now I **continue my work** on this project **as a copy**.

There should be no breaking changes related to this transfer. Most of the external links should not be broken. The repository link is also the same: [arkivanov/MVIKotlin](https://github.com/arkivanov/MVIKotlin). Please file an issue in this repository, if you think something is broken or does not work properly.

Here is what is mostly affected by the transfer:

- All the stars were transferred

- All the issues and discussions were transferred as well. I will do all my best to fill the gap here.

- All pull requests with all the comment history are also gone.

I will continue doing all my best for this project and for the community! Business as usual!

Additional resources:

- [A thread on Hacker News](https://news.ycombinator.com/item?id=29447854)

## Overview

### 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.  



#### Responsibilities and architecture

MVIKotlin does not bring or enforce any particular architecture. There is one primary responsibility of the library:

- 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.

There are also two optional responsibilities, which the library can take care of for you: 

- To provide an abstraction for UI with efficient updates (diffing).

- To provide lifecycle aware connections (bindings) between inputs and outputs.

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.

If you are using declarative UI frameworks (like [Jetpack Compose](https://developer.android.com/jetpack/compose), [Multiplatform Compose by JetBrains](https://github.com/JetBrains/compose-jb), SwiftUI, React, etc.), then consider using [Decompose](https://github.com/arkivanov/Decompose) for architecture. MVIKotlin plays nicely with Decompose.

Also one of the architecture approaches can be found in the [samples](#sample-project).

## 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, see the [documentation](https://arkivanov.github.io/MVIKotlin/state_preservation.html))

- `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::"

```

## Features

* Multiplatform: Android, JVM, iOS, watchOS, tvOS, macOS, linuxX64, JavaScript, Wasm (since `4.0.0-alpha02`)

* 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)

* Lifecycle-aware connections (bindins) between inputs and outputs

* Logging functionality with customizable logger and formatter

* Time travel feature:

    * Multiplatform for all supported targets

    * 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

    * Chrome DevTools [extension](https://chrome.google.com/webstore/detail/mvikotlin-time-travel/johehgbnhfknbbdndfcablclpopcoaee) for Web browser apps

## Documentation

[https://arkivanov.github.io/MVIKotlin](https://arkivanov.github.io/MVIKotlin)

## Sample project

The sample project is a todo list with details view. There are two implementations of the same sample, one using Reaktive library and another one using coroutines. Each variant has Android, iOS and Web browser apps. This samples also demonstrates one of the possible architectures for a multiplatform project - each screen is represented by a controller class, platform applications integrate controllers and navigate between them.

### Structure

* Shared database - [sample/database](sample/database)

* Reaktive sample - [sample/reaktive](sample/reaktive)

    * Shared module - [sample/reaktive/shared](sample/reaktive/shared)

    * Android application - [sample/reaktive/app-android](sample/reaktive/app-android)

    * iOS Xcode project - [sample/reaktive/app-ios](sample/reaktive/app-ios)

    * Web browser application - [sample/reaktive/app-js](sample/reaktive/app-js)

* Coroutines sample - [sample/coroutines](sample/coroutines)

    * Shared module - [sample/coroutines/shared](sample/coroutines/shared)

    * Android application - [sample/coroutines/app-android](sample/coroutines/app-android)

    * iOS Xcode project - [sample/coroutines/app-ios](sample/coroutines/app-ios)

    * Web browser application - [sample/coroutines/app-js](sample/coroutines/app-js)

## Sample TodoApp in JetBrains/compose-jb

There is another sample project available in forked repository of `JetBrains/compose-jb` - [TodoApp](https://github.com/IlyaGulya/TodoAppDecomposeMviKotlin). It uses MVIKotlin for business logic and [Decompose](https://github.com/arkivanov/Decompose) for navigation.

## 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

[![Debugging Android application with MVIKotlin](https://img.youtube.com/vi/_bbxR503-u0/0.jpg)](https://youtu.be/_bbxR503-u0)

#### Debugging iOS application with MVIKotlin

[![Debugging iOS application with MVIKotlin](https://img.youtube.com/vi/MJCYQzeL-w8/0.jpg)](https://youtu.be/MJCYQzeL-w8)

#### Debugging Android application with IntelliJ IDEA time travel plugin

[![Debugging Android application with IntelliJ IDEA time travel plugin](https://img.youtube.com/vi/Tr2ayOcVU34/0.jpg)](https://youtu.be/Tr2ayOcVU34)

#### Debugging iOS application using MVIKotlin time travel client app

[![Debugging iOS application using MVIKotlin time travel client app](https://img.youtube.com/vi/rj6GwA2ZQkk/0.jpg)](https://youtu.be/rj6GwA2ZQkk)