README_EN.md

MVVM-Rhine

The MVVM using RxJava2 and Android Jetpack.

English Documentation | 中文文档

ScreenShots

Libraries

Android Jetpack

• Lifecycle: Create a UI that automatically responds to lifecycle events.

• LiveData: Build data objects that notify views when the underlying database changes.

• ViewModel: Store UI-related data that isn't destroyed on app rotations. Easily schedule asynchronous tasks for optimal execution.

• Room: Access your app's SQLite database with in-app objects and compile-time checks.

• Navigation: Handle everything needed for in-app navigation.

• Paging: Makes it easier for you to load data gradually and gracefully within your app's RecyclerView.

Http

• Retrofit2: Type-safe HTTP client for Android and Java by Square, Inc.

• OkHttp: An HTTP+HTTP/2 client for Android and Java applications.

DI

• Kodein-DI: Painless Kotlin Dependency Injection

ReactiveX

• RxKotlin: RxJava bindings for Kotlin

• RxJava2: A library for composing asynchronous and event-based programs using observable sequences for the Java VM

• RxAndroid: RxJava bindings for Android

• RxBinding: RxJava binding APIs for Android's UI widgets.

• RxPermissions: Android runtime permissions powered by RxJava2.

• RxWeaver: A lightweight and flexible error handler tools for RxJava2.

• AutoDispose: Automatic binding+disposal of RxJava 2 streams.

Functional

• Arrow: Functional companion to Kotlin's Standard Library.

Others

• Glide: An image loading and caching library for Android focused on smooth scrolling

• Timber: A logger with a small, extensible API which provides utility on top of Android's normal Log class.

Tools

• MVVM-Rhine-Template: Activity or Fragment code generation template for MVVM-Rhine.

Usage

Step1: Fork this repo directly:

$ git clone https://github.com/qingmei2/MVVM-Rhine.git

Step2: Register OAuth Application.

Step3: Put the Client ID and the Client Secret into local.properties:

CLIENT_ID = "xxxxxx"
CLIENT_SECRET = "xxxxxx"

Thanks to

🎨 The UI design of this project refers to gitme.

⭐ This repo is inspired by rx-mvvm-android and uses some of its source code.

License

The MVVM-Rhine: Apache License

Copyright (c) 2018 qingmei2

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.