Quickstart guide
Requirements
- Flutter 3.3.0 or later.
- Dart SDK 3.7.0 or later.
- Android: minimum API level 24.
- iOS: minimum deployment target 15.0.
- Recommended: An SSH key configured locally and registered with GitHub.
Installation
To install the DevRev SDK, run the following command:
It automatically fetches the latest version of our package and adds it to your project’s pubspec.yaml file:
Alternatively, you can add the dependency manually by adding the package to your pubspec.yaml
file under the dependencies
section and run flutter pub get
to install the package.
To get the latest version of the SDK, you can check the pub.dev page.
Set up the DevRev SDK
- Open the DevRev web app at https://app.devrev.ai and go to the Settings page.
- Under PLuG settings copy the value under Your unique App ID.
- Configure the DevRev SDK in your app using the obtained credentials.
The DevRev SDK must be configured before you can use any of its features.
The SDK becomes ready for use once the following configuration method is executed.
For example:
Sample app
A sample app with use cases for the DevRev SDK for Flutter has been provided as a part of our public repository. To set up and run the sample app:
-
Go to the
sample
directory: -
Install dependencies:
-
iOS app: Open the
ios/Runner.xcworkspace
in Xcode for running the iOS app or run the following command.Additional Steps for iOS before running the app:
- Change the minimum iOS deployment target version to
15.0
. - Go to the
ios
directory and performpod install
. - Open
ios/Runner.xcodeproj
in Xcode and selectPackage dependencies -> FlutterGeneratedPluginSwiftPackage -> Package.swift
set iOS version from12
to15
. - Perform
File -> Packages -> Resolve package versions
. - Build and run the app.
- Change the minimum iOS deployment target version to
-
Android app: Open the
android
directory in Android Studio or run the following command.