Ripple
A browser based, platform agnostic mobile application development and testing tool.
All source code (excluding third party libraries) are subject to:
Copyright (c) 2011 Research In Motion Limited
License
All assets in this repository, unless otherwise stated through sub-directory LICENSE or NOTICE files, are subject to the Apache Software License v.2.0.
In particular, the assets under ext/assets/images are excluded from the Apache Software License v.2.0. Please see the NOTICE file for more details.
Build Requirements
-
nodejs, npm
nodejs: v0.4.12 is preferred. Later versions are not tested.
npm: If you are located behind a firewall, you might need to set up a proxy for npm. Just edit ~/.npmrc and add your proxy accordingly. registry = http://registry.npmjs.org/ proxy = http://some.business.com:8080 -
OSX or linux (windows is not currently supported for development)
Getting Started
./configure
This script will pull down the needed npm packages and initialize the submodules.
Build Commands
jake
This will build ripple to the pkg/ folder. In that folder there is a web directory and a chromium directory.
To test ripple as an extension in chrome/chromium just load the chromium folder as an unpacked extension.
jake -T
This will describe all the available commands for building and running the tests
Running Inside Other Web Browsers
Ripple is (by-design) browser agnostic, and is able to run inside any web browser (with disabled web security).
To get it running inside Chrome you should start it with these command line flags:
--app=http://path/to/ripple-ui/pkg/web
--disable-web-security
--user-data-dir=/path/to/dummy/profile
Code Guidelines
- 4 spaces per editor tab
- jake lint, no new lint errors introduced
- all unit tests are green
Reference Material & Community
You can also find associated reference material for the Ripple tool as well as contributor forums at the following locations.