https://github.com/synerise/synerise-flutter-sdk
Synerise SDK plugin for Flutter
https://github.com/synerise/synerise-flutter-sdk
Last synced: about 1 year ago
JSON representation
Synerise SDK plugin for Flutter
- Host: GitHub
- URL: https://github.com/synerise/synerise-flutter-sdk
- Owner: Synerise
- License: apache-2.0
- Created: 2023-01-24T13:06:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-15T07:50:10.000Z (about 1 year ago)
- Last Synced: 2025-04-15T08:35:06.877Z (about 1 year ago)
- Language: Dart
- Size: 604 KB
- Stars: 6
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Synerise Flutter SDK (synerise-flutter-sdk) (2.1.0)
[](https://github.com/synerise/ios-sdk)
[](https://github.com/synerise/android-sdk)
[](https://github.com/synerise/synerise-flutter-sdk)
[](https://synerise.com)
[](https://hub.synerise.com/developers/mobile-sdk/)
---
## About
[Synerise](https://www.synerise.com) SDK plugin for Flutter.
## Documentation
Most up-to-date documentation is available at [Developer Guide - Mobile SDK](https://hub.synerise.com/developers/mobile-sdk).
## Requirements
* Access to workspace
* A Profile API Key
* Development environment configured - [Flutter documentation](https://docs.flutter.dev)
## Android
* Minimum Android SDK version - 21
* Supported targetSDKVersion - 33
### iOS
* Xcode 15 and iOS SDK 17
* iOS 9.0+ minimum deployment target
* Valid architectures: arm64 devices and arm64, x86_64 simulators
## Installation
### With flutter
```
$ flutter pub add synerise_flutter_sdk
```
This will add a line like this to your package's pubspec.yaml (and run an implicit flutter pub get):
```
dependencies:
synerise_flutter_sdk: ^1.3.0
```
Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.
### Path dependency
via ssh:
```
synerise_flutter_sdk:
git:
url: git@github.com:Synerise/synerise-flutter-sdk.git
```
or
via https:
```
synerise_flutter_sdk:
git:
url: https://github.com/Synerise/synerise-flutter-sdk.git
```
### Importing Synerise SDK
```
import 'package:synerise_flutter_sdk/synerise.dart';
```
## Android gradle & configuration
Add to the `android/build.gradle`:
```
repositories {
google()
mavenCentral()
maven { url 'https://pkgs.dev.azure.com/Synerise/AndroidSDK/_packaging/prod/maven/v1' }
}
```
in MainActivity add:
```
public class MainActivity extends FlutterActivity {
@Override
public void configureFlutterEngine(@NonNull FlutterEngine flutterEngine) {
super.configureFlutterEngine(flutterEngine);
SyneriseMethodChannel.configureChannel(flutterEngine);
}}
```
## iOS configuration
In iOS portion of your application (/ios) you will need to run `pod update`.
## Initialization
First of all, you need to initialize Synerise Flutter SDK and provide `Profile API Key`.
To get `Profile API Key`, please sign in to your Synerise account and visit [https://app.synerise.com/settings/apikeys](https://app.synerise.com/settings/apikeys).
Then, generate new `API Key` for `Profile` audience.
```
Synerise.initializer()
.withClientApiKey("YOUR_PROFILE_API_KEY")
.init();
```
## Running example app
- Open project folder in selected IDE
- `flutter pub get` in the terminal (dependencies pull)
- Select the device/emulator in your IDE (for ios part it is required to run `pod update` in example/ios directory)
- Fill the file `api_key.txt` located in `example/lib` with your profile api key
- Make sure the firebase related files `example/ios/Runner/GoogleService-Info.plist` and `example/android/app/google-services.json` are filled with your firebase project configuration data
- Run the example app via selected sdk or execute `cd example` and `flutter run` in the terminal
## Changelog
Changelog can be found [here](./CHANGELOG.md).
## Author
Synerise, developer@synerise.com. If you need support please feel free to contact us.