Skip to content

Commit

Permalink
prepare 1.0.0 readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CarGuo committed Nov 5, 2018
1 parent fe1db3e commit ade3317
Show file tree
Hide file tree
Showing 8 changed files with 140 additions and 0 deletions.
Binary file added 1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
116 changes: 116 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
![](https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/logo.png)

## 一款Android原生的开源Github客户端App,提供更丰富的功能,更好体验,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验~~Σ( ̄。 ̄ノ)ノ。项目使用`Retrofit2 + RxJava2 + Dagger2 + DataBinding + LiveData + Navigation` 等,MVVM 配合 Android JetPack,涉及各种常用控件,提供丰富的同款对比:

* ### 同款Weex版 ( https://github.com/CarGuo/GSYGithubAppWeex
* ### 同款ReactNative版 ( https://github.com/CarGuo/GSYGithubApp
* ### 同款Flutter版 ( https://github.com/CarGuo/GSYGithubAppFlutter


```
基于 Kotlin 开发的原生 App 。目前初版,持续完善中。
项目的目的是为方便个人日常维护和查阅 Github ,更好的沉浸于码友之间的互基,Github 就是你的家。
项目同时适合 Android 和 Kotlin 的练手学习,覆盖了各种框架的使用。
随着项目的使用情况和反馈,将时不时根据更新并完善用户体验与功能优化吗,欢迎提出问题。
```
-----


## 相关文章

>敬请期待


[![GitHub stars](https://img.shields.io/github/stars/CarGuo/GSYGithubAppKotlin.svg)](https://github.com/CarGuo/GSYGithubAppKotlin/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/CarGuo/GSYGithubAppKotlin.svg)](https://github.com/CarGuo/GSYGithubAppKotlin/network)
[![GitHub issues](https://img.shields.io/github/issues/CarGuo/GSYGithubAppKotlin.svg)](https://github.com/CarGuo/GSYGithubAppKotlin/issues)
[![GitHub license](https://img.shields.io/github/license/CarGuo/GSYGithubAppKotlin.svg)](https://github.com/CarGuo/GSYGithubAppKotlin/blob/master/LICENSE)

### 编译运行流程


>### 重点:你需要项目根目录下,配置 `local.properties` 文件,然后输入你申请的Github client_id 和 client_secret。

CLIENT_ID = "xxxxxx"
CLIENT_SECRET = "xxxxxx"


  [ 注册 Github APP 传送门](https://github.com/settings/applications/new),当然,前提是你现有一个github账号(~ ̄▽ ̄)~ 。



### 下载

>敬请期待



### 常见问题


>敬请期待



### 示例图片


<img src="https://github.com/CarGuo/GSYGithubAppKotlin/blob/master/1.jpg" width="426px"/>

<img src="https://github.com/CarGuo/GSYGithubAppKotlin/blob/master/2.jpg" width="426px"/>

<img src="https://github.com/CarGuo/GSYGithubAppKotlin/blob/master/3.jpg" width="426px"/>


### 第三方框架

|| 功能 |
| ----------------------- | ----------------------- |
| **retrofit2** | **网络** |
| **okHttp3** | **网络** |
| **rxJava2** | **异步事件处理** |
| **dagger2** | **依赖注入** |
| **dataBinding** | **数据绑定** |
| **liveData/viewModel** | **数据订阅** |
| **navigation** | **Android JetPack 导航** |
| **aRouter** | **组件化路由** |
| **glide** | **图片加载** |
| **realm** | **数据库** |
| **iconics** | **矢量图标** |
| **navigationtabbar** | **TabBar** |
| **lazyRecyclerAdapter** | **通用绑定RecyclerView适配器** |
| **markdownView** | **Markdown解析** |
| **prism4j** | **代码高亮** |
| **materialDrawer** | **drawer** |
| **lottie** | **svg动画** |
| **gson** | **json解析** |

### 进行中:

>敬请期待


<img src="https://github.com/CarGuo/GSYGithubAppKotlin/blob/master/thanks.jpg" width="426px"/>


### LICENSE
```
CarGuo/GSYGithubAppFlutter is licensed under the
Apache License 2.0
A permissive license whose main conditions require preservation of copyright and license notices.
Contributors provide an express grant of patent rights.
Licensed works, modifications, and larger works may be distributed under different terms and without source code.
```




24 changes: 24 additions & 0 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,30 @@ android {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}

signingConfigs {
debug {
storeFile file("../gsygithubapp-debug.jks")
storePassword "123456"
keyAlias "debug"
keyPassword "123456"
}
release {
storeFile file("../gsygithubapp-debug.jks")
storePassword "123456"
keyAlias "debug"
keyPassword "123456"
}
}

buildTypes {
debug {
signingConfig signingConfigs.debug
}
release {
signingConfig signingConfigs.release
}
}
}

dependencies {
Expand Down
Binary file added gsygithubapp-debug.jks
Binary file not shown.
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added thanks.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ade3317

Please sign in to comment.