init

Author: nightwolf-chen

Diff for: .gitignore

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.

Diff for: CHANGELOG.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alibaba Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Diff for: LICENSE.md

@@ -0,0 +1,270 @@
+<p align="center">
+  <img src="flutter_boost.png">
+   <b></b><br>
+  <a href="README_CN.md">中文文档</a>
+  <br><br>
+</p>
+
+# 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
+You need to add Flutter to your project before moving on.
+
+# Getting Started
+
+
+## Add a dependency in you Flutter project.
+
+Open you pubspec.yaml and add the following line to dependencies:
+
+Before release 1.0
+
+```java
+flutter_boost: 0.0.34
+```
+
+
+After Release 1.0
+
+```java
+flutter_boost: ^0.0.39
+```
+
+
+## Integration with Flutter code.
+Add init code to you App
+
+```dart
+void main() => runApp(MyApp());
+
+class MyApp extends StatefulWidget {
+  @override
+  _MyAppState createState() => _MyAppState();
+}
+
+class _MyAppState extends State<MyApp> {
+  @override
+  void initState() {
+    super.initState();
+
+    ///register page widget builders,the key is pageName
+    FlutterBoost.singleton.registerPageBuilders({
+      'sample://firstPage': (pageName, params, _) => FirstRouteWidget(),
+      'sample://secondPage': (pageName, params, _) => SecondRouteWidget(),
+    });
+
+    ///query current top page and load it
+    FlutterBoost.handleOnStartPage();
+  }
+
+  @override
+  Widget build(BuildContext context) => MaterialApp(
+      title: 'Flutter Boost example',
+      builder: FlutterBoost.init(), ///init container manager
+      home: Container());
+}
+```
+
+
+## Integration with iOS code.
+
+Use FLBFlutterAppDelegate as the superclass of your AppDelegate
+
+```objc
+@interface AppDelegate : FLBFlutterAppDelegate <UIApplicationDelegate>
+@end
+```
+
+
+Implement FLBPlatform protocol methods for your App.
+
+```objc
+@interface DemoRouter : NSObject<FLBPlatform>
+
+@property (nonatomic,strong) UINavigationController *navigationController;
+
++ (DemoRouter *)sharedRouter;
+
+@end
+
+
+@implementation DemoRouter
+
+- (void)openPage:(NSString *)name
+          params:(NSDictionary *)params
+        animated:(BOOL)animated
+      completion:(void (^)(BOOL))completion
+{
+    if([params[@"present"] boolValue]){
+        FLBFlutterViewContainer *vc = FLBFlutterViewContainer.new;
+        [vc setName:name params:params];
+        [self.navigationController presentViewController:vc animated:animated completion:^{}];
+    }else{
+        FLBFlutterViewContainer *vc = FLBFlutterViewContainer.new;
+        [vc setName:name params:params];
+        [self.navigationController pushViewController:vc animated:animated];
+    }
+}
+
+
+- (void)closePage:(NSString *)uid animated:(BOOL)animated params:(NSDictionary *)params completion:(void (^)(BOOL))completion
+{
+    FLBFlutterViewContainer *vc = (id)self.navigationController.presentedViewController;
+    if([vc isKindOfClass:FLBFlutterViewContainer.class] && [vc.uniqueIDString isEqual: uid]){
+        [vc dismissViewControllerAnimated:animated completion:^{}];
+    }else{
+        [self.navigationController popViewControllerAnimated:animated];
+    }
+}
+
+@end
+```
+
+
+
+Initialize FlutterBoost with FLBPlatform at the beginning of your App.
+
+```objc
+ [FlutterBoostPlugin.sharedInstance startFlutterWithPlatform:router
+                                                        onStart:^(FlutterViewController *fvc) {
+                                                            
+                                                        }];
+```
+
+## Integration with Android code.
+
+Init FlutterBoost in Application.onCreate() 
+
+```java
+public class MyApplication extends FlutterApplication {
+    @Override
+    public void onCreate() {
+        super.onCreate();
+        FlutterBoostPlugin.init(new IPlatform() {
+            @Override
+            public Application getApplication() {
+                return MyApplication.this;
+            }
+
+            /**
+             * get the main activity, this activity should always at the bottom of task stack.
+             */
+            @Override
+            public Activity getMainActivity() {
+                return MainActivity.sRef.get();
+            }
+
+            @Override
+            public boolean isDebug() {
+                return false;
+            }
+
+            /**
+             * start a new activity from flutter page, you may need a activity router.
+             */
+            @Override
+            public boolean startActivity(Context context, String url, int requestCode) {
+                return PageRouter.openPageByUrl(context,url,requestCode);
+            }
+
+            @Override
+            public Map getSettings() {
+                return null;
+            }
+        });
+    }
+```
+
+
+# Basic Usage
+## Concepts
+
+All page routing requests are being sent to the native router. Native router communicates with Native Container Manager, Native Container Manager takes care of building and destroying of Native Containers. 
+
+
+## Use Flutter Boost Native Container to show a Flutter page in native code.
+
+iOS
+
+```objc
+ FLBFlutterViewContainer *vc = FLBFlutterViewContainer.new;
+        [vc setName:name params:params];
+        [self.navigationController presentViewController:vc animated:animated completion:^{}];
+```
+
+Android
+
+```java
+public class FlutterPageActivity extends BoostFlutterActivity {
+
+    @Override
+    public void onRegisterPlugins(PluginRegistry registry) {
+        //register flutter plugins
+        GeneratedPluginRegistrant.registerWith(registry);
+    }
+
+    @Override
+    public String getContainerName() {
+        //specify the page name register in FlutterBoost
+        return "sample://firstPage";
+    }
+
+    @Override
+    public Map getContainerParams() {
+        //params of the page
+        Map<String,String> params = new HashMap<>();
+        params.put("key","value");
+        return params;
+    }
+}
+```
+
+or
+
+```java
+public class FlutterFragment extends BoostFlutterFragment {
+    @Override
+    public void onRegisterPlugins(PluginRegistry registry) {
+        GeneratedPluginRegistrant.registerWith(registry);
+    }
+
+    @Override
+    public String getContainerName() {
+        return "sample://firstPage";
+    }
+
+    @Override
+    public Map getContainerParams() {
+        Map<String,String> params = new HashMap<>();
+        params.put("key","value");
+        return params;
+    }
+}
+```
+
+
+## Use Flutter Boost to open a page in dart code.
+
+Dart
+
+```objc
+ FlutterBoost.singleton.openPage("pagename", {}, true);
+```
+
+## Use Flutter Boost to close a page in dart code.
+
+```objc
+FlutterBoost.singleton.closePageForContext(context);
+```
+
+# Running the Demo
+Please see the example for details.
+
+
+# License
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+# Acknowledgments
+* Flutter