A browser based, platform agnostic mobile application development and testing tool.
- nodejs, npm
- OSX or linux (windows is not currently supported for development)
If you plan to dive into the source, be sure to check out the HACKING file.
To get started, you need to setup a few things, first- run (in the project root):
This script will pull down the needed npm packages and initialize the submodules.
This will build ripple to the
pkg/ folder. In that folder there are various targets that can be used.
This will describe all the available commands for building and running the tests, etc.
Running As A Chrome Extension
- Go to the extension management page (chrome://chrome/extensions/) in chrome.
- Ensure that you have selected the developer mode checkbox.
- Click the Load Unpacked extension button.
- Select the
NOTE: For development you should be fine to just build with jake and refresh your browser. If you end up editing anything in the ext folder you will need to refresh the extension from the extension management page.
For more information see doc/chrome_extension.md.
Running Inside Other Web Browsers
Ripple is (by-design) browser agnostic, and should be able to run inside any web browser.
If you want to run it inside other browsers, you will need to use the
pkg/hosted target, paired with the CLI's
Ex (using the NPM package):
ripple emulate --path to/my/app # or ripple emulate --remote http://remote-site.com
Then navigating to (your app's html file):
CLI & NPM Package
There is a command line interface that can be paired with the client (UI).
It can be used for various things, such as statically hosting an application, and running a local (cross origin) XHR proxy.
npm install -g ripple-emulator
This will install a global script called
ripple. To see usage, run:
master branch is the latest (stable) release. The
next branch is where all development happens.
If you like the project, and want to contribute code, please issue a pull request (on GitHub) into the
Note: You will need to submit an Apache ICLA (Individual Contributor License Agreement) for your contribution to be accepted.
- 4 spaces per editor tab.
jake lint, no new lint errors introduced.
- All unit tests are green.