1.0.3 (Oct 17, 2014)
May 25, 2013
Mar 9, 2022
Couchbase Labs (couchbaselabs)
Traun Leyden (tleyden)
Hideki Itakura (hideki)
Pasin Suriyentrakorn (pasin)
Marty Schoch (mschoch)
Bastian (bastianvs)
Jim Borden (borrrden)
James Nocentini (jamesnocentini)
Source code
APK file


⚠️ This repo is obsolete. It was built against a version of Couchbase Lite that reached end of life years ago.

Grocery Sync for Couchbase Lite Android

An example app that uses the Couchbase Lite Android mobile database framework.

This example code corresopnds to the master branch of Couchbase Lite Android.


If Couchbase Lite is configured to sync it's changes with a Sync Gateway, then all changes will automatically background sync bi-directionally such that any changes on either device will propagate to the other.

Install Android Studio


The following screencasts walk you through getting GrocerySync up and running:

The screencasts follow the instructions in the remainder of this document.

Getting the code

$ git clone
$ git submodule update --init

Import the project in Android Studio

Follow the same instructions as importing Couchbase Lite

Run the app via Android Studio

  • Run it using the "play" or "debug" buttons in the UI

Congratulations! If you got this far and see this UI, you have your first Couchbase Lite Android app up and running.

Install Sync Gateway

  1. Download and install Sync Gateway (see the installation page for details).

  2. Start Sync Gateway with the configuration file in the root of this project.

    ~/Downloads/couchbase-sync-gateway/bin/sync_gateway sync-gateway-config.json
  3. Open and update the SYNC_URL constant to point to your Sync Gateway instance.

    public static final String SYNC_URL = "";
    • If you are using the Genymotion emulator:
    • If you are using the standard android emulator:
    • If you are running on a device: http://<ip of sync gw>:4984/grocery-sync
  4. Build and run the app.

  5. Add items and they should be visible on the Sync Gateway Admin UI at [http://localhost:4985/_admin/] (http://localhost:4985/_admin/).

Change the dependency from Maven -> Direct code dependency (optional)

By default, this project depends on the Couchbase Lite maven artifacts. However, it can also depend on the CBLite code directly, which is useful if you need to modify the Couchbase Lite code. (Note: if you are using maven artifacts, since we ship the source code artifacts, you should already be able to browse the code and debug)

See the build.gradle and settings.gradle files for instructions on how to do this.

Run via Gradle (optional)

If you would rather run the project via the command line, you can do the following:

  • Run the android emulator
  • Run ./gradlew clean && ./gradlew installDebug
  • Switch to the emulator and you should have a new app called GrocerySync-Android
  • Tap it to open the app

Compile with submodules (Couchbase Lite from source code) (optional)

If you would rather compile the project with couchbase lite source codes, you can do the following:

  • Open sttings.gradle, remove /* and */.
  • Open build.gradle in GrocerySync-Android folder, comment out compile 'com.couchbase.lite:couchbase-lite-android:1.1.0' and remove // for compile project(':libraries:couchbase-lite-android'), compile project(':libraries:couchbase-lite-java-core'), and compile project(':libraries:couchbase-lite-java-native:sqlite-default').

Additional Information

Where to go from here: creating your own Couchbase-Lite app

See the Getting Started Guide.


See Getting Help