https://github.com/zhuinden/androidreactor
AndroidReactor is a framework for a reactive and unidirectional Android application architecture.
https://github.com/zhuinden/androidreactor
Last synced: 2 months ago
JSON representation
AndroidReactor is a framework for a reactive and unidirectional Android application architecture.
- Host: GitHub
- URL: https://github.com/zhuinden/androidreactor
- Owner: Zhuinden
- License: apache-2.0
- Created: 2019-01-23T13:20:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-23T14:01:18.000Z (over 6 years ago)
- Last Synced: 2025-02-07T08:49:08.740Z (4 months ago)
- Language: Kotlin
- Size: 154 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AndroidReactor
 
AndroidReactor is a framework for a reactive and unidirectional Android application architecture.
It is an Android port of the [ReaktorKit](https://github.com/ReactorKit/ReactorKit/) iOS concept.
## Installation
```groovy
allprojects {
repositories {
jcenter()
}
}
...
dependencies {
implementation 'at.florianschuster:androidreactor:0.0.1'
}
```
## What should I know before I try this?
* Android (duh)
* Kotlin
* RxJava2
* nice to have: Lifecycle Architecture Components
* nice to have: MVI Architecture Pattern
## Tell me more
### General Concept and Unidirectional Data Flow
For this you should hit up the [ReactorKit Repo Readme](https://github.com/ReactorKit/ReactorKit/blob/master/README.md). It is very extensive and since Swift 4 and Kotlin are much alike you will feel right at home! They also have nice graphics.
### Android Specific
A Reactor has to implment the `Reactor` interface. Do not forget to dispose the `CompositeDisposable` in the `Reactor` after you are done with it (the `ViewModelReactor` handles this for you). A View that binds to a Reactor has to implement the interface `ReactorView`.
When binding the Reactor to an Activity or a Fragment, their life cycles have to be taken into account.
All views have to be laid out before the bind happens, so you should not call `fun bind(Reactor)` before:
* Activity's `fun onCreate(Bundle)`
* Fragment's `fun onActivityCreated(Bundle)`
Also do not forget to dispose the View's `CompositeDisposable`. I propose to do this in:
* Activity's `fun onDestroy()`
* Fragment's `fun onDestroyView()`
The `ViewModelReactor` is a default implementation for a `Reactor`, however it is only a suggestion of how the Reactor could be implemented!
## Examples
* [Counter](https://github.com/floschu/AndroidReactor/tree/master/countersample): Most Basic Counter Example.
* [Github Search](https://github.com/floschu/AndroidReactor/tree/master/githubsample): Github Repository Search.
* [Watchables](https://github.com/floschu/Watchables): A Movie and TV Show Watchlist Application.
## Author
Visit my [Website](https://florianschuster.at/).
## License
```
Copyright 2019 Florian Schuster.
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.
```