Installation

Add the Koolbase SDK to your Flutter project and get auth, database, storage, realtime, feature flags, and functions in one package.

Requirements

Flutter≥ 3.0.0
Dart≥ 3.0.0
iOS≥ 13.0
AndroidAPI 21+

Install the SDK

Add the Koolbase SDK to your pubspec.yaml:

pubspec.yamlYAML
dependencies:
  flutter:
    sdk: flutter
  koolbase: ^1.4.0

Or install via the command line:

flutter pub add koolbase

Then fetch dependencies:

flutter pub get

What's Included

The koolbase package includes the full platform in one dependency:

Koolbase.authRegister, login, sessions, email verification, password reset
Koolbase.dbJSONB collections, CRUD, access rules, realtime subscriptions
Koolbase.storageFile upload, download, and delete via Cloudflare R2
Koolbase.realtimeWebSocket subscriptions for live data updates
Koolbase.flagsFeature flags with percentage rollouts and targeting
Koolbase.configRemote config values updated without app releases
Koolbase.versionForce or soft-prompt users to update the app

Android Setup

Add internet permission to your AndroidManifest.xml:

android/app/src/main/AndroidManifest.xmlXML
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-permission android:name="android.permission.INTERNET" />
    ...
</manifest>

Ensure your minSdkVersion is at least 21:

android/app/build.gradleGroovy
android {
    defaultConfig {
        minSdkVersion 21
        ...
    }
}

iOS Setup

No additional configuration required. Koolbase works out of the box on iOS 13+. Ensure your deployment target is set to iOS 13.0 or higher in Xcode.

Internal Dependencies

The Koolbase SDK manages these dependencies automatically:

httpAPI requests
web_socket_channelRealtime WebSocket subscriptions
shared_preferencesLocal caching of flags and config
flutter_secure_storageSecure session token storage
package_info_plusApp version detection for version enforcement
cryptoPercentage-based rollout bucketing

Verify Installation

Confirm the SDK was installed correctly:

flutter pub deps | grep koolbase

You should see koolbase 1.4.0 in the output.