Couchbase-Lite-Android

Couchbase-Lite-Android is a lightweight embedded NoSQL database engine for Android with the built-in ability to sync to Couchbase Server on the backend.

It is the Android port of Couchbase Lite iOS.

Architecture

Couchbase Lite databases are able to sync with eachother via Sync Gateway backed by Couchbase Server

Documentation Overview

• This README
• Official Documentation for 1.0 release
• Javadocs for 1.0 release
• Wiki

Getting started with Couchbase Lite

• Download and run the GrocerySync demo application

• Create your own Hello World Couchbase Lite via the Getting Started guide.

Getting the pre-built jars / maven artifacts

Maven master branch

Maven repo URL: http://files.couchbase.com/maven2/

<dependency>
  <groupId>com.couchbase.lite</groupId>
  <artifactId>android</artifactId>
  <version>0.0.0-396</version>
</dependency>

While 0.0.0-396 was the latest build at the time of writing, it's probably out of date by the time you are reading this. To get the latest build number (eg, the "396" part of the version above), see our Maven Repo and look for the highest numbered version that starts with 0.0.0- and is later than 0.0.0-396

Here is a complete gradle file that uses this maven artifact.

Maven 1.0 release

Maven repo URL: http://files.couchbase.com/maven2/

<dependency>
  <groupId>com.couchbase.lite</groupId>
  <artifactId>android</artifactId>
  <version>1.0.0-75</version>
</dependency>

Zipfile that includes jars

For Eclipse and Phonegap users, here are links to the zip file which includes the jars:

• Master Branch build #396 zipfile - to get more recent builds, see Jenkins CI builds
• 1.0.0 zipfile

Building Couchbase Lite from source

Prerequisites

• Download Android Studio. Versions 0.5.7 and 0.5.8 are known to work. Anything older will almost certainly not work. Newer versions after 0.5.8 may or may not work. (if not, please report an issue)

• Under Tools / Android / Android SDK Manager and install "Extras/Google Repository" and "Extras/Android Support Repository" (future versions of Android Studio may make this step unnecessary)

Clone the git repository

Use Git to clone the Couchbase Lite repository to your local disk:

$ git clone git://github.com/couchbase/couchbase-lite-android.git
$ cd couchbase-lite-android
$ git submodule init && git submodule update

Configure Android Studio SDK location

• cp local.properties.example local.properties
• Customize local.properties according to your SDK installation directory

Enable settings.gradle file

• cp settings.gradle.example settings.gradle

Importing Project into Android Studio

You should be able to import the project directly into Android Studio:

• Start Android Studio
• Choose File / Import and choose the settings.gradle file in the couchbase-lite-android directory you cloned earlier
• Hit Finish and wait for all tasks to finish (may take a while)

Running tests

There are two wiki pages which describe how to run the tests:

• Running unit tests for couchbase lite android (newer)

• Running the Test Suite wiki page.

Example Apps

• GrocerySync
  • Simplest example
• TodoLite
  • Facebook auth
  • Replication with channels
  • Image attachments
  • Ability for users to share data
• LiteServAndroid
  • REST API example

Project Structure

• Project Structure wiki page that describes the new project structure.

Requirements

• Android 2.3 Gingerbread (API level 9) and above.

Getting Help

• Couchbase Mobile Google Group
• File a github issue

Credits

Credits

License

• Apache License 2.0