Mulberry takes content from your filesystem and turns it into a working mobile app on Android and iOS. It also provides a local development server for testing your app, and a framework for adding custom functionality and CSS.
- Google Group
- #touramulberry on irc.freenode.net: A live chat room with Mulberry users and developers. Use your own IRC client or use Freenode's webchat
Clone this repository to a location of your choosing.
git clone email@example.com:Toura/mulberry.git
Add the full path to
mulberry/binto your path by editing your profile and adding the following:
For example, if you cloned the repository to
would add the following to your
Install bundler if it is not already installed (note that you will need to have rubygems installed; it is installed by default on OSX):
gem install bundler
From the root directory of the repository, run the following command:
You're done! You should now be able to run mulberry from any directory.
Mulberry currently supports the following mobile platforms:
- iOS4 and above on iPhone and iPad
- Android 2.2 and above on Phone only
Mulberry apps have been shown to run on WebOS, although not bug-free.
Mulberry apps do not support Windows Mobile or BlackBerry in any version.
Mulberry development tools are supported on the following platforms:
- OSX Snow Leopard and Lion
Mulberry development is not supported on Linux, but it might work. Please let us know at firstname.lastname@example.org if you can get it working on a particular Linux distro.
We do not currently support running Mulberry on Windows or any other OS; however, some work has been done to get it working on Windows -- additional pull requests welcome!
Mulberry supports PhoneGap 1.1. Any other version will not work.
Go to the PhoneGap download page and download the 1.1.0 release. Extract it to a convenient directory.
Installing iOS Phonegap Library
In the extracted phonegap directory, go into iOS, and run the installer. The xcode project will call the lib that is installed to your computer.
You do not need to install droidgap as the Android project template included in Mulberry already contains the compiled results.
To build and run apps on iOS Simulator, you must:
Own an Intel Mac running OSX Snow Leopard or Lion
Download Xcode 4.1 or greater (preferably 4.2) from the Mac App Store
In order to submit your apps to the Apple iOS App Store, you must sign up with Apple's iOS Developer Program
To build and run apps on Android Simulator, you must:
Install Java JDK 1.6 or above. This should install the java compiler (javac -version should return 1.6.x)
JAVA_HOMEenvironment variable is pointing to the Java directory
You may have to install Apache ant (
which ant). We develop with ant 1.8.x (ant -version) http://ant.apache.org
Download Android SDK package for your platform
On OSX, extract it to
/Developer/SDKs/android-sdk-mac_x86/. If you do not place it in this directory, Mulberry should detect the location of it, but this is the preferred location.
Edit your shell's loading files (
.bash\_profilefor bash and
.zshrcfor zsh) and add a line similar to:
Open a new teminal and run the SDK manager:
Click "Available packages"
Expand "Android Repository"
You should install:
- "Android SDK Tools" (latest revision)
- "Android SDK Platform-tools" (latest revision)
- SDK Platform Android 2.2, 2.3.x, 2.n (up to latest revision)
- SDK Platform Android 3.x
Expand "Third party Add-ons", then install:
- Google APIs 8, 9 (up to latest revision)
Be careful, as some tools require certain revisions, so if you see "Skipping 'X'; it depends on 'Y'" you'll have to go back and choose X again.
Keep doing this until you've installed everything.
You do not need, but may choose, to install the Samples and Documentation. It's pretty useless and just takes up space.
Creating an Android Virtual Device
Run the SDK manager by running
android on the command line.
On the "Virtual Devices" section click the "New..." button
Name the device
Select the Google APIs - API Level 8 (to test 2.2) as the target
Make the SD card size 64 MB
Click "Create AVD"
Now you can run the device by running
emulator @your-device-name -partition-size 128
To rotate the device hit 7 or 9 on your numeric keypad. If you don't have one: CTRL-F12 to rotate to landscape, CTRL-F11 to rotate back.
Installing to your Android Virtual Device
Start the emulator, then type:
adb install -r /path/to/your.apk
See the github issues list https://github.com/Toura/mulberry/issues/
Running the tests
To run the tests, simply run
rake from the root of the repository. You can
also run individual suites: