README.md

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 each other via Sync Gateway backed by Couchbase Server.

Other ways to setup replication:

• No replication -- just local data store.
• Peer-to-peer repolication between Couchbase Lite instances.
• Replication to multiple Sync Gateway instances rather than a single Sync Gateway.
• Etc ..

Documentation Overview

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

Getting started with Couchbase Lite

• Download and run the GrocerySync and TodoLite demo applications.

• Create your own Hello World Couchbase Lite via the Getting Started guide. (warning: these Getting Started guide correspond to the 1.0.0 release of Couchbase Lite, so you may run into issues with later releases.)

Adding Couchbase Lite to your Gradle project

Using Gradle is the easiest way to automate Couchbase Lite builds in your project.

Important note: Maven artifacts can only be included with gradle builds, since the mvn tool does not know how to resolve and build .aar dependencies.

Using latest official release

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

<dependency>
  <groupId>com.couchbase.lite</groupId>
  <artifactId>android</artifactId>
  <version>${latest_version}</version>
</dependency>

Where ${latest_version} should be replaced by something that looks like 1.0.3. To find the latest version, check our Maven Repo directly and look for the latest version, ignoring anything that has a dash after it. (Eg, ignore items like 1.0.3-239 because they aren't official releases).

Using master branch version (bleeding edge)

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

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

While 0.0.0-473 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 "473" 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-473

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

Zipfile that includes jars

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

• Master Branch build #473 zipfile - to get more recent builds, see Jenkins CI builds
• To get the latest released zipfile, go to the official download site and download the latest release.

Building Couchbase Lite via Android Studio

If you just want the pre-built binaries, see instructions above. The instructions that follow explain how to build Couchbase Lite from source.

Android Studio compatibility table

These are known working versions. Other versions might be compatible (eg, later versions are likely to be compatible)

Couchbase Lite Version	Android Studio Version
1.0.0	Android Studio 0.5.7
1.0.1	Android Studio 0.5.7
1.0.2	Android Studio 0.8.2
1.0.3.x	Android Studio 0.8.2 - 0.8.9
Master	Android Studio 1.0

Prerequisites

• Download Android Studio.

• Under Tools / Android / Android SDK Manager make sure "Extras/Google Repository" and "Extras/Android Support Repository" are installed.

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

Enable settings.gradle file

• cp settings.gradle.example settings.gradle

Note: settings.gradle cannot be checked in directly due to Android Studio issue #65915

Importing Project into Android Studio

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

• Start Android Studio
• Choose File / Import Project and choose the settings.gradle file in the couchbase-lite-android directory you cloned earlier. (Note: if you are on the welcome screen, choose "Import Non-Android Studio Project)
• Hit Finish and wait for all tasks to finish (may take a while)

Caveat: when importing, you may see Wrong offset: 290. Should be in range: 0, 230, but after that you should be able to click the menu bar item "Sync Project with Gradle files" and the project should work.

Running tests in Android Studio

See Running unit tests for couchbase lite android

Running project in Android Studio

If you've checked out this project directly, you might notice there is nothing to run. That is correct, as this project is a library.

If you want to run something (aside from the tests), you should get one of the sample apps listed below.

Building Couchbase Lite on command line via gradle

• Clone the git repository
  • See details above
• Enable settings.gradle file
  • See details above
• If you don't already have a local.properties file, configure Android Studio SDK location
  • cp local.properties.example local.properties
  • Customize local.properties according to your SDK installation directory
• Build and test
  • $ ./gradlew build

Example Apps

• GrocerySync
  • Simplest example
• TodoLite
  • Facebook auth
  • Replication with channels
  • Image attachments
  • Ability for users to share data
• LiteServAndroid
  • REST API example
• TestCouchLiteAndroid
  • Simple example contributed by @iraycd

System Requirements

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

Limitations

• Docs are limited to 2MB - see issue 357
• Attachments are limited to 20MB if using Sync Gateway

Getting Help

• Couchbase Mobile Google Group
• File a github issue -- please follow the bug reporting guidelines

Credits

Credits

License

• Apache License 2.0