Install Couchbase Lite in react-native app to enable JSON sync.

Usage no npm install needed!

<script type="module">
  import 7oussemReactNativeCouchbaselite from 'https://cdn.skypack.dev/@7oussem/react-native-couchbaselite';



Getting started

$ npm install react-native-couchbaselite --save

Mostly automatic installation

$ react-native link react-native-couchbaselite

Manual installation


  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-couchbaselite and add RNCouchbaseLite.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNCouchbaseLite.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<


  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import com.reactlibrary.RNCouchbaseLitePackage; to the imports at the top of the file
  • Add new RNCouchbaseLitePackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-couchbaselite'
    project(':react-native-couchbaselite').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-couchbaselite/android')
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      compile project(':react-native-couchbaselite')


Read it! :D

  1. In Visual Studio add the RNCouchbaseLite.sln in node_modules/react-native-couchbaselite/windows/RNCouchbaseLite.sln folder to their solution, reference from their app.
  2. Open up your MainPage.cs app
  • Add using Couchbase.Lite.RNCouchbaseLite; to the usings at the top of the file
  • Add new RNCouchbaseLitePackage() to the List<IReactPackage> returned by the Packages method


import RNCouchbaseLite from 'react-native-couchbaselite';

// TODO: What to do with the module?