commit	7830f1ac70c26a5bb3da909b2081040657337bd7	[log] [tgz]
author	Tim Barham <tim.barham@microsoft.com>	Wed May 27 16:07:06 2015 -0700
committer	Tim Barham <tim.barham@microsoft.com>	Wed May 27 16:07:06 2015 -0700
tree	4e96025316726245b3b33dd7427440805aa0b86a
parent	c57039dd1a65686ac35db4c4cca9650b3bf005ab [diff]

tree: 4e96025316726245b3b33dd7427440805aa0b86a

README.md

Apache Ripple(tm)

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

Build Requirements

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

If you like the project, and want to contribute code, please issue a pull request (on GitHub) into the master branch.

Note: You will need to submit an Apache ICLA (Individual Contributor License Agreement) for your contribution to be accepted.