Skip to content

Getting Started

Welcome! This section guides you through setting up AirDB in your project, creating your first local database, and synchronizing data between devices over Bluetooth.

We recommend following these guides in order:

  1. Installation & Setup: Add AirDB to your Android Gradle or Apple Swift package configuration, and set up required Bluetooth permissions.
  2. 5-Minute Quickstart: Write your first working code to initialize the database, start the engine, and record a mutation.
  3. Apple Platforms Guide: Learn how AirDbKit leverages Swift concurrency and native Apple frameworks with zero third-party dependencies.
  4. Hands-On Tutorial: Walk through a complete, realistic scenario—building an offline disaster triage registry with two independent nodes.

What You Will Need

  • For Android Development: Android Studio, Kotlin 2.0+, and an Android device or emulator running Android 8.0 (API 26) or higher.
  • For Apple Development: Xcode 15+, Swift 5.9+, and a device running iOS 14+, macOS 12+, or watchOS 7+.
  • For JVM Simulation: Any desktop operating system with Java 17+ installed.