Prerequisites

Couchbase Lite for React Native is provided as a Native Module. Version 1.1 supports React Native New Architecture through TurboModules on iOS and Android.

The Native Module can be found at the following repository: Couchbase Lite for React Native. npm package: @couchbase/couchbase-lite-react-native. Shared TypeScript and JavaScript code lives in cblite-js.

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

• React Native
• React Native - Native Modules
• React Native - New Architecture
• Expo Framework
• Couchbase Lite

Expo Note

React Native's recommmendation is to use Expo for development . The example app that comes with the repository is an Expo based app, thus this Native Module can work in Expo apps. Note using Expo Go is not supported due to Expo Go not supporting loading 3rd party Native Modules. You will need to be familiar with the Expo Dev Client process to use this Native Module in an Expo app.

Supported Platforms

• The React Native - Native Module is supported on iOS and Android platforms. MacOS, Windows, and Web support is not available at this time.

React Native Version

• The plugin is built using React Native 0.76.3. Support for older versions of React Native is not guaranteed and apps should be based on 0.76.3 or higher.
• Version 1.1 supports TurboModules through React Native New Architecture. Apps should enable New Architecture when using the TurboModule implementation.

Please review the React Native Support documentation for a full listed of supported platform versions.

Development Environment

• Javascript
  • Node >= 20
• React Native
  • React Native Docs
  • Understanding React Native - Native Modules
• Expo (if you choose to use Expo, not required but recommended)
  • Expo Docs
  • Expo Dev Client
  • Expo Mono Repos
  • Expo Plugin and mods
• IDEs
  • Visual Studio Code
  • IntelliJ IDEA
• iOS Development
  • A modern Mac
  • XCode 15.1 or higher installed and working
  • [iOS 15.1 or higher]. Any apps using the plugin must be upgraded to iOS 15.1 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 24 (Android 7)] or higher. Any apps using the plugin must be upgraded to API 24 or higher. Any older versions of Android are not supported by React Native and Expo.
  • 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