Mirror of Apache Ripple
Clone or download
Permalink
Failed to load latest commit information.
assets Updates URLs for documentation and download to the Apache Incubator s… Apr 16, 2015
bin 'bin/ripple' is executed with node, which does not support "#" comments. May 15, 2013
build Remove dredd.txt and fail.txt. Aug 29, 2015
doc v0.9.32 Aug 17, 2015
lib Add support for Insomnia-PhoneGap-Plugin. Oct 19, 2015
targets/chrome.extension Updates URLs for documentation and download to the Apache Incubator s… Apr 16, 2015
test Fixed a couple of test problems May 12, 2015
thirdparty Remove dredd.txt and fail.txt. Aug 29, 2015
.bowerrc Remove git submodule support by changing how Jasmine is pulled in. May 21, 2013
.csslintrc Non WebKit specific vendor prefixes should not be in any CSS files. Aug 15, 2012
.gitignore Adds 'jake rat' task to run Apache RAT, which verifies license header… May 12, 2015
.jshintignore The current build/ext folder structure needs to be simplified. Oct 24, 2012
.jshintrc Triple equals and unused function vars are too terse for this project. Apr 24, 2014
DISCLAIMER RIPPLE-77 Need to include DISCLAIMER and NOTICE files in package Feb 16, 2015
HACKING.md RIPPLE-75 Some source files are missing Apache 2.0 license header. Jan 29, 2015
Jakefile Improve jake lint. Jun 18, 2015
LICENSE LICENCE and NOTICE file updates. Jul 23, 2015
NOTICE LICENCE and NOTICE file updates. Jul 23, 2015
README.md The next branch no longer exists. May 14, 2015
RETIRED.txt Add RETIRED.txt to top level of repo. Jan 31, 2016
bower.json Remove git submodule support by changing how Jasmine is pulled in. May 21, 2013
configure Remove git submodule support by changing how Jasmine is pulled in. May 21, 2013
package.json v0.9.32 Aug 17, 2015

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

Getting Started

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.

Build Commands

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.

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

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.

To install:

npm install -g ripple-emulator

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

ripple help

Contributing

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.

Code Guidelines

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

Reference Material & Community