Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript Java Other
Branch: master
Pull request Compare This branch is 21 commits ahead of couchbaselabs:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.phonegap
assets
examples
libs
phonegap
res
src/com
welcome
.classpath
.gitignore
.project
AndroidManifest.xml
Couchbase.zip
LICENSE-2.0.txt
README.md
ant.properties
build.xml
couchbase.xml
proguard.cfg
project.properties

README.md

Android-TouchDB-Cordova

This app is a demonstration of the TodoMVC backbone-require app, which has been modified to work as a Backbone boilerplate project. It is based upon Android-Couchbase-Callback.

The TodoMVC project serves as a demonstration of popular javascript MV* frameworks. I am using TodoMVC as a generic project called couchabb to help assess TouchDB-Android performance.

You may also use this app to deploy a CouchApp to an Android device using TouchDB-Android and Apache Cordova (formerly PhoneGap).

Requirements

This project requires the latest version of the Android SDK. If you already have the SDK tools, you can upgrade by running android update sdk, if you don't have them, you can install via this link

Getting Started

These instructions are divided into two sections, the first describes the development mode.
In this mode you can continually couchapp push your changes in for test. T he second describes distribution mode where you package your application for distribution.

Development

  1. Clone this repository
  2. Create a local.properties pointing to your Android SDK

    sdk.dir=...

  3. Build this application, either using eclipse or command line tools

    ant debug

  4. Install/Launch this application on your device/emulator

    adb install bin/AndroidCouchbaseCallback-debug.apk

    adb shell am start -n com.couchbase.callback/.AndroidCouchbaseCallback

  5. TouchDB is now running. The TodoMVC app will display. Sometimes the app will not display; check for the following message: 05-11 17:36:00.251: D/CordovaLog(2647): Error: Load timeout for modules: use This issue happens in Android 2.2 emulator; Android 2.3 works fine. You should be able to view the app after setting up adb below at via http://localhost:8990/couchabb/_design/couchabb/index.html

  6. Forward the Couchbase Mobile from the device to your development machine (the Couchbase port is dynamic and is shown on the screen)

    adb forward tcp:8990 tcp:8888

  7. From within your CouchApp project directory, run the following command to install your couchapp on the device.

    couchapp push . http://localhost:8990/couchabb

Distribution

  1. Copy the database off the device and into this Android application's assets directory. To keep the filesystem clean, first create a directory named your_couchapp in your project assets dir. In the console, cd to that directory. Run the following commmand:

    adb pull /data/data/com.couchbase.callback/files/your_couchapp

This should have put an attachments directory in that directory.

  1. Now cd up one directory (to your assets dir) and run the following command:

    adb pull /data/data/com.couchbase.callback/files/your_couchapp.touchdb

  2. Edit res/raw/coconut.properties and change coconut-sample to the name of your couchapp and adjust the couchAppInstanceUrl. Note that you can also change the port in this file.

    app_db=coconut-sample couchAppInstanceUrl=_design/coconut/index.html

  3. Repackage your application with the database file included

    ant debug

  4. Reinstall the application to launch the CouchApp

    adb uninstall com.couchbase.callback

    adb install bin/AndroidCouchbaseCallback-debug.apk

    adb shell am start -n com.couchbase.callback/.AndroidCouchbaseCallback

Examples

Android Couchbase Callback now includes a couple of sample applications to help you get started.

Assumptions

A few assumptions are currently made to reduce the number of options that must be configured to get started. Currently these can only be changed by modifying the code.

  • The name of the database can be anything (couchapp is used in the examples above). BUT, the design document must have the same name.

Further Customizations

  • Change the name and package of your application

    Refactor name and package of ExampleAppActivity to suit your needs

  • Provide your own custom splash screen

    Override the getSplashScreenDrawable() method to point to your splash screen image

Frequently Asked Questions

Q: When I start my application the splash screen shows for a long time, then I get the message "Application Error: The connection to the server was unsuccessful." In the background behind this message I now see my application. But when I press OK, the application exits. What is going on?

A: Most likely your application is loading a resource (something like the _chagnes feed) and this causes the PhoneGap container to fail to recognize that the page has loaded. The fix is simple, add a function to your application that listens for the "deviceReady" event and start your work after this event fires. For example:

document.addEventListener("deviceready", onDeviceReady, false);

function onDeviceReady() {
    //  start listenting to changes feed here
}

We are still looking for a better approach to this problem.

TODO

  • spoof a call to onPageFinished so that phonegap paints the screen even if a long ajax call happens before onload.

License

Portions under Apache, Erlang, and other licenses.

The overall package is released under the Apache license, 2.0.

Copyright 2011-2012, Couchbase, Inc.

Something went wrong with that request. Please try again.