Skip to main content

Prerequisites

Couchbase Lite for Ionic Capacitor is provided as a Capacitor Plugin.

The plugin can be found at the following repository Couchbase Lite for Ionic Capacitor. This plugin is actively developed and maintained by the community. It is not an official Couchbase product.

A developer using this plugin should have a basic understanding of the following technologies:

Supported Platforms​

  • The capacitor plugin is supported on iOS and Android platforms. Web support is not available.

Capacitor Version​

The plugin is built using Capacitor 6.1.2 and also supports Capacitor 7. The plugin doesn't use any Ionic Framework specific code, so it should work with any version of Ionic that supports Capacitor 6.1.2 or Capacitor 7+.

Note: Capacitor 7 has different minimum requirements than Capacitor 6.1.2. Please review the requirements below based on the version you plan to use.

Development Environment​

Common Requirements (Both Capacitor v6 & v7)​

Capacitor 6.1.2 Requirements​

  • Javascript
  • iOS Development
    • A modern Mac
    • XCode 15 or higher installed and working
    • [iOS 13 or higher]. Any apps using the plugin must be upgraded to iOS 13 or higher.
    • XCode Command Line Tools installed
    • Simulators downloaded and working
    • Homebrew
    • Cocopods
    • A valid Apple Developer account and certificates installed and working
  • Android Development
    • [API 23 (Android 6)] or higher. Any apps using the plugin must be upgraded to API 23 or higher. Any older versions of Android are not supported.
    • Android Studio installed and working
    • Android SDK 34 >= installed and working (with command line tools)
    • Java SDK v17 installed and configured to work with Android Studio
    • An Android Emulator downloaded and working

Capacitor 7+ Requirements​

  • Javascript
  • iOS Development
  • Android Development
    • [API 23 (Android 6)] or higher minimum SDK. Any apps using the plugin must be upgraded to API 23 or higher.
    • Compile SDK >= Version 35
    • Target SDK >= Version 35
    • Android Studio 2024.2.1 (Ladybug) or newer installed and working
    • Android SDK 35 installed and working (with command line tools)
    • Java SDK v21 (JDK 21) installed and configured to work with Android Studio
    • An Android Emulator downloaded and working