Skip to main content

Installation

To installing Ionic's Couchbase Lite integration into your app, first check the prerequisites to make sure your app is compatible, and then install the package into your app.

Prerequisites#

Important: Ionic's Couchbase Lite integration uses Couchbase Lite Enterprise, and requires an existing Couchbase subscription with access to enterprise mobile functionality.

Ionic's Couchbase Lite integration requires Capacitor 3.0 or above, and is not compatible with Cordova-based Ionic apps. We strongly recommend migrating to Capacitor and we offer official migration support to help your team navigate the transition.

Installation#

To get started, install the @ionic-enterprise/couchbase-lite package into your Ionic/Capacitor app:

npm install @ionic-enterprise/couchbase-lite

Then, sync your Capacitor app to load any native dependencies:

npx cap sync# orionic capacitor sync

Once installed, move onto Usage to see how to start using Couchbase Lite in your app.