README.md 8.3 KB
Newer Older
J
JessYan 已提交
1
![Logo](image/arms_banner_v1.0.jpg)
J
JessYan 已提交
2
![Official](image/official.jpeg)
J
JessYan 已提交
3

J
JessYan 已提交
4
<p align="center">
J
JessYan 已提交
5 6
   <a href="https://bintray.com/jessyancoding/maven/MVPArms/_latestVersion">
    <img src="https://img.shields.io/badge/Jcenter-v2.5.0-brightgreen.svg?style=flat-square" alt="Latest Stable Version" />
J
JessYan 已提交
7 8 9 10
  </a>
  <a href="https://travis-ci.org/JessYanCoding/MVPArms">
    <img src="https://travis-ci.org/JessYanCoding/MVPArms.svg?branch=master" alt="Build Status" />
  </a>
J
jessyan 已提交
11 12
  <a href="https://developer.android.com/about/versions/android-4.0.html">
    <img src="https://img.shields.io/badge/API-14%2B-blue.svg?style=flat-square" alt="Min Sdk Version" />
J
JessYan 已提交
13 14 15 16
  </a>
  <a href="http://www.apache.org/licenses/LICENSE-2.0">
    <img src="http://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square" alt="License" />
  </a>
J
JessYan 已提交
17 18 19
  <a href="https://www.jianshu.com/u/1d0c0bc634db">
    <img src="https://img.shields.io/badge/Author-JessYan-orange.svg?style=flat-square" alt="Author" />
  </a>
J
JessYan 已提交
20
  <a href="https://shang.qq.com/wpa/qunwpa?idkey=7e59e59145e6c7c68932ace10f52790636451f01d1ecadb6a652b1df234df753">
J
JessYan 已提交
21
    <img src="https://img.shields.io/badge/QQ%E7%BE%A4-455850365%20%7C%20301733278-orange.svg?style=flat-square" alt="QQ Group" />
J
JessYan 已提交
22 23 24 25 26 27 28 29
  </a>
</p>

<p align="center">
  <a href="MVPArms.md">
    <b>中文说明</b>
  </a>
</p> 
J
jessyan 已提交
30

J
JessYan 已提交
31
## A common Architecture for Android Applications developing based on MVP, integrates many Open Source Projects (like Dagger2、RxJava、Retrofit ...), to make your developing quicker and easier.
J
jess 已提交
32

J
jessyan 已提交
33
## Architectural
J
jessyan 已提交
34
<img src="https://github.com/JessYanCoding/MVPArms/raw/master/image/Architecture.png" width="80%" height="80%">
J
jessyan 已提交
35

J
jessyan 已提交
36
## Usage
J
JessYan 已提交
37
> New Project (**The following steps are too cumbersome? Now you can use the [new feature (generate an app Module with one click)](https://github.com/JessYanCoding/MVPArms-Module-Template) in new projects, to avoid the cumbersome configuration of the project, to quickly open the world of MVPArms**)
J
JessYan 已提交
38
>> If you are building a new project, directly to the entire project **clone** (or download), as **demo** as the main **Module** (It is recommended to remove the **arms Module** and use **Gradle** to [depend](https://github.com/JessYanCoding/MVPArms/wiki#1.1) on this framework remotely for easy updates), then the package name into their own package name, **demo Module** contains the package structure can be used directly, a mainstream `MVP` +` Dagger2` + `Retrofit` +` RxJava` framework so easy to build successful, and now you refer **Mvp** Package under the **UserActivity** format, [Use Template to automatically generate MVP, Dagger2 related classes](https://github.com/JessYanCoding/MVPArmsTemplate), With access to [Wiki documents](https://github.com/JessYanCoding/MVPArms/wiki) slowly grasp the framework to see more articles as soon as possible in the project to use it, in practice, learning is the fastest
J
jessyan 已提交
39

J
jess 已提交
40
> Old Project
J
jessyan 已提交
41
>> [Old projects would like to introduce this framework, you can refer to the Wiki documentation, written in great detail](https://github.com/JessYanCoding/MVPArms/wiki)
J
jess 已提交
42

J
jessyan 已提交
43
## Wiki
J
JessYan 已提交
44
[Detailed usage reference Wiki (**Must see!!!**)](https://github.com/JessYanCoding/MVPArms/wiki)
J
jess 已提交
45

J
jessyan 已提交
46

J
jessyan 已提交
47
## Notice
J
jess 已提交
48

J
JessYan 已提交
49 50
* [MVPArms Learning Project](https://github.com/JessYanCoding/MVPArms/blob/master/CONTRIBUTING_APP.md)

J
jessyan 已提交
51 52
* [Collection Box](https://github.com/JessYanCoding/MVPArms/issues/40)

J
jessyan 已提交
53 54
* [Update Log](https://github.com/JessYanCoding/MVPArms/wiki/UpdateLog)

J
jessyan 已提交
55
* [Common Issues](https://github.com/JessYanCoding/MVPArms/wiki/Issues)
J
jessyan 已提交
56

J
JessYan 已提交
57
* The use of these technologies for the latter part of the project maintenance and iterative, especially large projects is very helpful, but is to develop a pre-write a page to write a lot of `MVP`,` Dagger2` class and interface, which is indeed a headache for the development of pre- Now the framework has been able to [Template](https://github.com/JessYanCoding/MVPArmsTemplate) automatically generate some `MVP`,` Dagger2` template code, and now we can very easily use the framework.
J
jess 已提交
58

J
JessYan 已提交
59
* Use this frame comes with automatic screen adaptation function, please refer to [AndroidAutoSize](https://github.com/JessYanCoding/AndroidAutoSize).
J
jess 已提交
60

J
JessYan 已提交
61
* This framework does not provide any third-party libraries associated with the **UI**.
J
jess 已提交
62

J
jessyan 已提交
63
## Functionality & Libraries
J
jessyan 已提交
64 65
1. [`Mvp` Google's official` Mvp` architecture project, which contains several different schema branches (this is the Dagger branch).](https://github.com/googlesamples/android-architecture/tree/todo-mvp-dagger/)
2. [`Dagger2`](https://github.com/google/dagger)
J
jessyan 已提交
66
3. [`RxJava`](https://github.com/ReactiveX/RxJava)
J
jessyan 已提交
67 68
4. [`RxAndroid`](https://github.com/ReactiveX/RxAndroid)
5. [`Rxlifecycle`](https://github.com/trello/RxLifecycle)
J
JessYan 已提交
69 70 71 72 73
6. [`RxCache`](https://github.com/VictorAlbertos/RxCache)
7. [`RxPermissions`](https://github.com/tbruyelle/RxPermissions)
8. [`RxErroHandler`](https://github.com/JessYanCoding/RxErrorHandler)
9. [`Retrofit`](https://github.com/square/retrofit)
10. [`Okhttp`](https://github.com/square/okhttp)
J
JessYan 已提交
74
11. [`AndroidAutoSize`](https://github.com/JessYanCoding/AndroidAutoSize)
J
JessYan 已提交
75 76
12. [`Gson`](https://github.com/google/gson)
13. [`Butterknife`](https://github.com/JakeWharton/butterknife)
J
JessYan 已提交
77
14. [`AndroidEventBus`](https://github.com/hehonghui/AndroidEventBus)
J
JessYan 已提交
78 79 80 81
15. [`Timber`](https://github.com/JakeWharton/timber)
16. [`Glide`](https://github.com/bumptech/glide)
17. [`LeakCanary`](https://github.com/square/leakcanary)

J
JessYan 已提交
82 83
## Who is using MVPArms?

J
JessYan 已提交
84 85 86 87 88 89 90
**天府通** | **小顶家装 工长端** | **小顶家装 工人端** | **小顶家装 材料端** | **小顶网** |
:-------------------------------------------------------------------:|:----------:|:---------------:|:--------:|:--------------:|
[<img src="image/tianfutong_logo.png" width="80" height="80">](https://android.myapp.com/myapp/detail.htm?apkName=com.chinarainbow.tft) | [<img src="image/xiaoding_foreman_logo.png" width="80" height="80">](http://www.dggxdjz.com) | [<img src="image/xiaoding_worker_logo.png" width="80" height="80">](http://www.dggxdjz.com) | [<img src="image/xiaoding_material_logo.png" width="80" height="80">](http://www.dggxdjz.com) | [<img src="image/top_net_work_logo.png" width="80" height="80">](http://www.dgg.net/appload.htm) |
**天天视频** | **天天直播** | **中斗通航** | **中斗祥云** | **麋鹿旅行** |
[<img src="image/tiantian_video_logo.png" width="80" height="80">](http://sj.qq.com/myapp/detail.htm?apkName=com.dzwh.ttys) | [<img src="image/tiantian_live_logo.png" width="80" height="80">](http://www.25pp.com/android/detail_7611392/) | [<img src="image/tong_hang_logo.png" width="80" height="80">](https://fir.im/3176) | <img src="image/xiang_yun_logo.png" width="80" height="80">  | [<img src="image/mi_lu_logo.png" width="80" height="80">](http://android.myapp.com/myapp/detail.htm?apkName=com.elk.tourist) |
**汇财富** | **觅窝** | **晒墨宝** | **智播**  | **(Your App ...)** |
[<img src="image/hui_cai_fu_logo.png" width="80" height="80">](http://android.myapp.com/myapp/detail.htm?apkName=com.tahone.client) | [<img src="image/mi_wo_logo.png" width="80" height="80">](http://miwo.ai/) | [<img src="image/shaimobao_logo.png" width="80" height="80">](http://sj.qq.com/myapp/search.htm?kw=%E6%99%92%E5%A2%A8%E5%AE%9D)  | [<img src="image/zhibo_logo.png" width="80" height="80">](http://www.zhibocloud.cn/) | <img src="image/android_logo.png" width="80" height="80"> |
J
jessyan 已提交
91 92


J
jessyan 已提交
93
## Acknowledgements 
J
JessYan 已提交
94
Thanks to all the three libraries used in this framework **Author**, and all for the **Open Sourece** selfless contributions **Developer** and **Organizations**, so that we can better work and study, I will also spare time return to the open source community
J
jess 已提交
95

J
jessyan 已提交
96
## About Me
J
jessyan 已提交
97 98
* **Email**: <jess.yan.effort@gmail.com>  
* **Home**: <http://jessyan.me>
J
JessYan 已提交
99 100
* **掘金**: <https://juejin.im/user/57a9dbd9165abd0061714613>
* **简书**: <https://www.jianshu.com/u/1d0c0bc634db>
J
jess 已提交
101

J
jessyan 已提交
102
## License
J
jess 已提交
103
``` 
J
jess 已提交
104
 Copyright 2016, jessyan       
J
jess 已提交
105
  
J
jess 已提交
106 107
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
J
jess 已提交
108
   You may obtain a copy of the License at 
J
jess 已提交
109
 
J
jess 已提交
110
       http://www.apache.org/licenses/LICENSE-2.0 
J
jess 已提交
111 112 113 114 115 116 117

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