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 beta2 release
• Javadocs for beta2 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-272</version>
</dependency>

To get the latest build number (eg, the "272" part of the version above), see Jenkins CI builds

To see an example gradle configuration, see GrocerySync's build.gradle file

Maven beta2 release

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

<dependency>
  <groupId>com.couchbase.cblite</groupId>
  <artifactId>CBLite</artifactId>
  <version>1.0.0-beta2</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 #272 zipfile - to get more recent builds, see Jenkins CI builds
• Beta2 zipfile

Building Couchbase Lite from source

Prerequisites

• Download Android Studio

  • If you are using the beta2 release or stable branch of Couchbase Lite, use the latest version in the stable channel (currently Android Studio 0.3.X)

  • If you are using the master branch of Couchbase Lite, use the latest version in the canary channel (currently Android Studio 0.4.3)

• 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)

Note recent versions after Android Studio 0.4.3 are not able to import the project due to Issue #65915, so it's recommended to use Android Studio 0.4.3.

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

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 couchbase-lite-android/CouchbaseLiteProject directory screenshot
• Choose Import from External Model and make sure Gradle is selected screenshot
• Check the auto-import and the Use gradle wrapper (recommended) checkboxes screenshot
• Hit Finish and wait for all tasks to finish (may take a while)

After it's finished with the import, it should look like this

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

• TodoLite
• GrocerySync
• LiteServAndroid
• CouchChatAndroid -- just a stub at this point.

Project Structure

• Project Structure wiki page that describes the new project structure.
• A mailing list post describing the project structre

Requirements

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

Credits

Credits

License

• Apache License 2.0