README.md 5.29 KB
Newer Older
yangwu.jia's avatar
yangwu.jia committed
1
[![Build Status](https://travis-ci.com/alibaba/flutter_boost.svg?branch=master)](https://travis-ci.com/alibaba/flutter_boost) [![pub package](https://img.shields.io/pub/v/flutter_boost.svg)](https://pub.dartlang.org/packages/flutter_boost) [![codecov](https://codecov.io/gh/alibaba/flutter_boost/branch/master/graph/badge.svg)](https://codecov.io/gh/alibaba/flutter_boost)
justin's avatar
justin committed
2

Jidong Chen's avatar
init  
Jidong Chen committed
3 4 5 6
<p align="center">
  <img src="flutter_boost.png">
   <b></b><br>
  <a href="README_CN.md">中文文档</a>
Jidong Chen's avatar
Jidong Chen committed
7
  <a href="https://mp.weixin.qq.com/s?__biz=MzU4MDUxOTI5NA==&mid=2247484367&idx=1&sn=fcbc485f068dae5de9f68d52607ea08f&chksm=fd54d7deca235ec86249a9e3714ec18be8b2d6dc580cae19e4e5113533a6c5b44dfa5813c4c3&scene=0&subscene=131&clicktime=1551942425&ascene=7&devicetype=android-28&version=2700033b&nettype=ctnet&abtest_cookie=BAABAAoACwASABMABAAklx4AVpkeAMSZHgDWmR4AAAA%3D&lang=zh_CN&pass_ticket=1qvHqOsbLBHv3wwAcw577EHhNjg6EKXqTfnOiFbbbaw%3D&wx_header=1">中文介绍</a>
Jidong Chen's avatar
init  
Jidong Chen committed
8 9
</p>

yangwu.jia's avatar
yangwu.jia committed
10
# Release Note
yangwu.jia's avatar
yangwu.jia committed
11

yangwu.jia's avatar
yangwu.jia committed
12
Please checkout the release note for the latest 0.1.64 to see changes [0.1.64 release note](https://github.com/alibaba/flutter_boost/releases)
13

Jidong Chen's avatar
init  
Jidong Chen committed
14 15 16 17 18
# FlutterBoost
A next-generation Flutter-Native hybrid solution. FlutterBoost is a Flutter plugin which enables hybrid integration of Flutter for your existing native apps with minimum efforts.The philosophy of FlutterBoost is to use Flutter as easy as using a WebView. Managing Native pages and Flutter pages at the same time is non-trivial in an existing App. FlutterBoost takes care of page resolution for you. The only thing you need to care about is the name of the page(usually could be an URL). 
<a name="bf647454"></a>

# Prerequisites
yangwu.jia's avatar
yangwu.jia committed
19
You need to add Flutter to your project before moving on.The version of the flutter SDK requires v1.9.1+hotfixes, or it will compile error.
Jidong Chen's avatar
init  
Jidong Chen committed
20

yangwu.jia's avatar
yangwu.jia committed
21 22


yangwu.jia's avatar
yangwu.jia committed
23
# boost version description
yangwu.jia's avatar
yangwu.jia committed
24

Vadaski's avatar
Vadaski committed
25 26 27 28 29 30 31
| Flutter Boost Version | Support Flutter SDK Version | Description                                                  | Support AndroidX? |
| --------------------- | --------------------------- | ------------------------------------------------------------ | ------------------ |
| 0.1.50                | 1.5.4-hotfixes              | android if other flutter versions or branches will compile incorrectly. | No                 |
| 0.1.51-0.1.59         | 1.5.4-hotfixes              | bugfix for 0.1.50.                                           | No                 |
| 0.1.60                | 1.9.1-hotfixes              | Android does not support andriodx if other flutter branches will compile incorrectly. | No                 |
| 0.1.61-0.1.69         | 1.9.1-hotfixes              | bugfix for 0.1.60.                                           | No                 |
| 0.1.63                | 1.9.1-hotfixes              | If other branches will compile incorrectly. Synchronize with the 0.1.60 code, and bugfix also merge to this branch. | No                 |
justin's avatar
justin committed
32
| 1.9.1+2              | 1.9.1-hotfixes              | Rename the version number and start supporting androidx by default | Yes                 |
justin's avatar
justin committed
33 34 35
| 1.12.13             | 1.12.13-hotfixes              | supporting androidx      | Yes                 |


yangwu.jia's avatar
yangwu.jia committed
36 37 38



yangwu.jia's avatar
yangwu.jia committed
39 40 41 42 43 44 45 46
| Flutter Boost branch | Support Flutter SDK Version | Description                                                  | Support AndroidX? |
| --------------------- | --------------------------- | ------------------------------------------------------------ | ------------------ |
| v1.9.1-hotfixes         | 1.9.1-hotfixes          | for androidx  | Yes                 |
| task/task_v1.9.1_support_hotfixes| 1.9.1-hotfixes  | for support  | NO                 |
| v1.12.13-hotfixes       | 1.12.13-hotfixes         | for androidx                                                        | Yes                 |
| task/task_v1.12.13_support_hotfixes| 1.12.13-hotfixes  | for support  | NO                 |


Jidong Chen's avatar
init  
Jidong Chen committed
47 48 49 50 51 52 53
# Getting Started


## Add a dependency in you Flutter project.

Open you pubspec.yaml and add the following line to dependencies:

yangwu.jia's avatar
yangwu.jia committed
54
androidx branch
yangwu.jia's avatar
yangwu.jia committed
55 56 57 58
```json
flutter_boost:
    git:
        url: 'https://github.com/alibaba/flutter_boost.git'
justin's avatar
justin committed
59
        ref: ' 1.12.13'
Jidong Chen's avatar
init  
Jidong Chen committed
60
```
yangwu.jia's avatar
yangwu.jia committed
61
support branch
yangwu.jia's avatar
yangwu.jia committed
62
```json
Jidong Chen's avatar
Jidong Chen committed
63
flutter_boost:
yangwu.jia's avatar
yangwu.jia committed
64 65
    git:
        url: 'https://github.com/alibaba/flutter_boost.git'
justin's avatar
justin committed
66
        ref: 'task/task_v1.12.13_support_hotfixes'
Jidong Chen's avatar
Jidong Chen committed
67 68 69
```


Jidong Chen's avatar
init  
Jidong Chen committed
70

yangwu.jia's avatar
yangwu.jia committed
71
# Boost  Integration
yangwu.jia's avatar
yangwu.jia committed
72

yangwu.jia's avatar
yangwu.jia committed
73
Please see the boost example for details.
Jidong Chen's avatar
init  
Jidong Chen committed
74

余玠's avatar
余玠 committed
75 76 77
# FAQ
please read this document:
<a href="Frequently Asked Question.md">FAQ</a>
Jidong Chen's avatar
init  
Jidong Chen committed
78 79 80 81 82


# License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

yangwu.jia's avatar
yangwu.jia committed
83

yangwu.jia's avatar
yangwu.jia committed
84 85 86 87 88 89
# Problem feedback group( dingding group)

<img width="200" src="https://img.alicdn.com/tfs/TB1JSzVeYY1gK0jSZTEXXXDQVXa-892-1213.jpg">



yangwu.jia's avatar
yangwu.jia committed
90

tino.wjf's avatar
tino.wjf committed
91
## 关于我们
yangwu.jia's avatar
yangwu.jia committed
92

tino.wjf's avatar
tino.wjf committed
93 94 95 96 97 98 99 100 101 102 103 104
阿里巴巴-闲鱼技术是国内最早也是最大规模线上运行Flutter的团队。

我们在公众号中为你精选了Flutter独家干货,全面而深入。

内容包括:Flutter的接入、规模化应用、引擎探秘、工程体系、创新技术等教程和开源信息。

**架构/服务端/客户端/前端/算法/质量工程师 在公众号中投递简历,名额不限哦**

欢迎来闲鱼做一个好奇、幸福、有影响力的程序员,简历投递:tino.wjf@alibaba-inc.com

订阅地址

tino.wjf's avatar
tino.wjf committed
105
<img src="https://img.alicdn.com/tfs/TB17Ki5XubviK0jSZFNXXaApXXa-656-656.png" width="328px" height="328px">
tino.wjf's avatar
tino.wjf committed
106 107

[For English](https://twitter.com/xianyutech "For English")