Skip to content

Commit 3410bc7

Browse files
committed
english readme
1 parent d0e4898 commit 3410bc7

2 files changed

Lines changed: 148 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
![](https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/logo.png)
22

3+
4+
#### [English Readme](https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/README_EN.md)
5+
36
## 一款跨平台的开源Github客户端App,提供更丰富的功能,更好体验,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验~~Σ( ̄。 ̄ノ)ノ。项目涉及各种常用控件、网络、数据库、设计模式、主题切换、多语言、Redux等。在开发学习过程中,提供丰富的同款对比:
47

58
* ### 同款Weex版 ( https://github.com/CarGuo/GSYGithubAppWeex )

‎README_EN.md‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
![](https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/logo.png)
2+
3+
## An open source Github client App developed by Flutter,Provide richer functionality and comparison with the same program by other language:
4+
5+
* ### Weex Version ( https://github.com/CarGuo/GSYGithubAppWeex )
6+
* ### ReactNative Version ( https://github.com/CarGuo/GSYGithubApp )
7+
* ### Android Kotlin Version( https://github.com/CarGuo/GSYGithubAppKotlin )
8+
9+
```
10+
Based on Flutter development, it adapts Android and IOS. At present, the first edition is in continuous improvement.
11+
12+
The purpose of the project is to facilitate personal daily maintenance and access to Github, better immerse in the mutual base between coders, Github is your home.
13+
14+
The project is also suitable for Flutter's hands-on learning, covering the use of various frameworks, interaction with native students and so on.
15+
16+
With the use and feedback of the project, will user experience and function optimization be updated and improved from time to time? Welcome to ask questions.
17+
```
18+
-----
19+
20+
21+
## Chinese Articles
22+
23+
* ### [Flutter 完整开发实战详解(一、Dart 语言和 Flutter 基础)](https://juejin.im/entry/5b631e3e51882519861c2ef1 )
24+
* ### [Flutter 完整开发实战详解(二、快速实战篇)](https://juejin.im/entry/5b685bd4e51d451994602cae )
25+
* ### [Flutter 完整开发实战详解(三、打包填坑篇)](https://juejin.im/entry/5b6fd5ee6fb9a009d36a4104 )
26+
* ### [Flutter 完整开发实战详解(四、Redux、主题、国际化)](https://juejin.im/post/5b79767ff265da435450a873 )
27+
* ### [Flutter 完整开发实战详解(五、深入探索)](https://juejin.im/post/5bc450dff265da0a951f032b )
28+
29+
30+
31+
32+
33+
[![GitHub stars](https://img.shields.io/github/stars/CarGuo/GSYGithubAppFlutter.svg)](https://github.com/CarGuo/GSYGithubAppFlutter/stargazers)
34+
[![GitHub forks](https://img.shields.io/github/forks/CarGuo/GSYGithubAppFlutter.svg)](https://github.com/CarGuo/GSYGithubAppFlutter/network)
35+
[![GitHub issues](https://img.shields.io/github/issues/CarGuo/GSYGithubAppFlutter.svg)](https://github.com/CarGuo/GSYGithubAppFlutter/issues)
36+
[![GitHub license](https://img.shields.io/github/license/CarGuo/GSYGithubAppFlutter.svg)](https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/LICENSE)
37+
38+
### Operation instructions
39+
40+
1. Configure the Flutter development environment (Tag of the current version of Flutter SDK ** v1.1.3 **).
41+
42+
2. Clone code, execute `Packages get'to install third-party packages.
43+
44+
45+
> ### 3. Emphasis: You need to create a `ignoreConfig.dart'file in the lib/common/config/directory by yourself, and then enter the Github client_id and client_secret you applied for.
46+
47+
class NetConfig {
48+
static const CLIENT_ID = "xxxx";
49+
50+
static const CLIENT_SECRET = "xxxxxxxxxxx";
51+
}
52+
53+
54+
  [ Register Github APP ](https://github.com/settings/applications/new) 。
55+
56+
<div>
57+
<img src="https://raw.githubusercontent.com/CarGuo/GSYGithubAppFlutter/master/register0.jpg" width="426px"/>
58+
<img src="https://raw.githubusercontent.com/CarGuo/GSYGithubAppFlutter/master/register1.jpg" width="426px"/>
59+
</div>
60+
61+
4、Be careful
62+
63+
>### Local Flutter SDK version v1.1.3 or more. 2. Does the third-party package version in pubspec. yaml correspond to the third-party package version in pubspec. lock?
64+
65+
66+
## Project Structure
67+
68+
![](https://raw.githubusercontent.com/CarGuo/GSYGithubAppFlutter/master/framework2.png)
69+
70+
![](https://raw.githubusercontent.com/CarGuo/GSYGithubAppFlutter/master/folder.png)
71+
72+
### 下载
73+
74+
#### Apk Download Link: [ Apk Download Link](https://www.pgyer.com/vj2B)
75+
76+
77+
| Type | Apk QR code |
78+
| ----------- | ---------------------------------------- |
79+
| **Apk QR code** | ![](https://raw.githubusercontent.com/CarGuo/GSYGithubAppFlutter/master/download.png) |
80+
| **IOS Null** | |
81+
82+
83+
84+
85+
### Demo
86+
87+
![](https://raw.githubusercontent.com/CarGuo/GSYGithubAppFlutter/master/ios.gif)
88+
89+
![](https://raw.githubusercontent.com/CarGuo/GSYGithubAppFlutter/master/theme.gif)
90+
91+
<img src="https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/1.jpg" width="426px"/>
92+
93+
<img src="https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/2.jpg" width="426px"/>
94+
95+
<img src="https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/3.jpg" width="426px"/>
96+
97+
98+
### Third-party framework
99+
100+
>Current Flutter SDK version v1.1.3
101+
102+
| 库 | 功能 |
103+
| -------------------------- | -------------- |
104+
| **dio** | **net** |
105+
| **shared_preferences** | **local storage** |
106+
| **fluttertoast** | **toast** |
107+
| **flutter_redux** | **redux** |
108+
| **device_info** | **device info** |
109+
| **connectivity** | **network status** |
110+
| **flutter_markdown** | **markdown parse** |
111+
| **json_annotation** | **json** |
112+
| **json_serializable** | **json** |
113+
| **url_launcher** | **intent** |
114+
| **iconfont** | **ttf** |
115+
| **share** | **share** |
116+
| **flutter_spinkit** | **loading** |
117+
| **get_version** | **version** |
118+
| **flutter_webview_plugin** | **webview** |
119+
| **sqflite** | **sqlite** |
120+
| **flutter_statusbar** | **status bar** |
121+
| **flutter_svg** | **svg** |
122+
| **photo_view** | **preview** |
123+
| **flutter_slidable** | **slide view** |
124+
| **flutter_cache_manager** | **cache manager** |
125+
| **path_provider** | **path** |
126+
| **permission_handler** | **permission** |
127+
| **scope_model** | **like redux** |
128+
129+
130+
<img src="https://github.com/CarGuo/GSYGithubAppFlutter/blob/master/thanks.jpg" width="426px"/>
131+
132+
133+
### LICENSE
134+
```
135+
CarGuo/GSYGithubAppFlutter is licensed under the
136+
Apache License 2.0
137+
138+
A permissive license whose main conditions require preservation of copyright and license notices.
139+
Contributors provide an express grant of patent rights.
140+
Licensed works, modifications, and larger works may be distributed under different terms and without source code.
141+
```
142+
143+
144+
145+
​

0 commit comments

Comments
 (0)