terra_flutter

A flutter plug-in for the native Terra library (Android and iOS).

Table of content

• Running example
  • Android
  • iOS
• Pigeon model
• Library usage
  • Initialize Terra App
  • Get Terra App
  • Get service config

Running example

Android

• Open example/android project with Android studio
• Add TekoGoogleRegistryToken to local.properties of this project

// example/android/local.properties

TekoGoogleRegistry.password=<your-token>

• Run project

iOS

• Setup github access token for accessing Teko iOS frameworks.

• Run commands below in the terminal

cd example
flutter build ios --no-codesign

• Launch Xcode and open example/ios/Runner.xcworkspace file

Pigeon model

This project use Pigeon to generate code for communication between Flutter and the native side.

The Pigeon file is located in the pigeon folder.

To generate code with Pigeon, please run run_pigeon.sh file.

Library usage

Initialize Terra App

Static Method: Future<TerraApp> initTerraApp

Initialize a new Terra App.You should call this function inside the entry-point to use other Terra services smoothly.

Get the Terra App

Static Method: `TerraApp TerraApp.getInstance(String appName)

Get the current Terra App that is identified by appName

Get service config

Method: Future<ServiceConfig> getServiceConfig()

Get a specific config in Terra