1.3.0 • Public • Published

PhoneGap plugin for Couchbase Lite

Couchbase Lite is an embedded JSON database for occasionally connected devices. It syncs data in the background, so users can collaborate across devices. There is an event based _changes JSON feed API so you can drive data-binding UI frameworks like Sencha and Backbone to reflect remote updates interactively.

It works with native code as well as Cordova / PhoneGap on iOS and Android (you can even sync with Mac desktops), so it doesn't matter where your users are, they can work with the data, and as soon as they get back online, everyone will see their changes.

Learn more about Couchbase Lite.

Quick start

You install Couchbase Lite into your PhoneGap app using the PhoneGap command line tools and this command (where $PLATFORM is either ios or android):

npm install -g phonegap
phonegap create MyPhoneGapApp
cd MyPhoneGapApp/
phonegap local plugin add https://github.com/couchbaselabs/Couchbase-Lite-PhoneGap-Plugin.git
phonegap run $PLATFORM

Congrats, you got to hello world. If you want to try a full example app, follow the instructions for 5 minutes to awesome


This is where the plugin fits in the picture:


Note: your JavaScript code can also directly communicate with Couchbase Lite over a Javascript<->Native bridge, to ask it what URL it has launched on for subsequent XHR access

Where to go from here

There's an example chat app with PhoneGap that illustrates the channel sync API. You can read more about the app here.

If you made it this far, you are now ready to build your custom PhoneGap App by editing the HTML, CSS, and Javascript files under the www directory. Your same application code will work on both the iOS and Android platforms!

Package Sidebar


npm i rds-couchdb

Weekly Downloads





Apache 2.0

Last publish


  • ravi013