Ripple Emulator(tm) — Archived

A browser based, platform agnostic mobile application development and testing tool.

Ripple Emulator is archived and the ripple-emulator npm package is deprecated. It has known security vulnerabilities and will not receive further updates or security fixes. Do not use it for new projects.

Use Cordova Simulate instead. Cordova Simulate replaces Ripple for simulating Apache Cordova applications in the browser. See its README for installation and usage instructions.

Version 0.9.37 is the final release, updating the documentation and package metadata to announce the archive. It does not fix the existing security issues.

The documentation below is retained for historical reference.

• Common

  • nodejs (v0.12.0 or higher)
  • npm (v2.5.1 or higher)
  • python (v2.7.3 recommended, v3.x.x is not supported)
    • Windows download

• OSX / Linux

  • make
  • A C/C++ compiler toolchain, e.g. GCC

• Windows

  • Visual Studio 2010
    • The setup instructions can be found here
  • msysgit
    • Ripple uses Bower for js libraries managing. In order to use Bower on Windows, msysgit must be installed in a proper way - see Bower's README.md

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):

./configure

This script will pull down the needed npm packages and initialize the submodules.

jake

This will build ripple to the pkg/ folder. In that folder there are various targets that can be used.

jake -T

This will describe all the available commands for building and running the tests, etc.

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 emulate command.

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):

http://localhost:PORT/index.html?enableripple=true

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.

To install:

npm install -g ripple-emulator

This will install a global script called ripple. To see usage, run:

ripple help

This project is archived and is no longer accepting contributions. For ongoing development, see Cordova Simulate.

• 4 spaces per editor tab.
• jake lint, no new lint errors introduced.
• All unit tests are green.

• Project Site