https://github.com/ripple-emulator/ripple

A browser based, platform agnostic mobile application development and testing tool.
https://github.com/ripple-emulator/ripple

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ripple-emulator/ripple
• Owner: ripple-emulator
• License: apache-2.0
• Created: 2016-02-05T01:23:55.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-09T08:31:35.000Z (almost 7 years ago)
• Last Synced: 2024-11-11T18:52:29.436Z (about 1 month ago)
• Language: JavaScript
• Size: 9.79 MB
• Stars: 46
• Watchers: 10
• Forks: 20
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cordova - ripple

README

        


# Ripple Emulator(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](http://www.python.org/download/releases/2.7.3#download)

* OSX / Linux

    * `make`

    * A C/C++ compiler toolchain, e.g. GCC

* Windows

  * Visual Studio 2010

    * The setup instructions can be found [here](https://github.com/brianmcd/contextify/wiki/Windows-Installation-Guide)

  * [msysgit](http://msysgit.github.io/)

    * Ripple uses [Bower](http://bower.io/) for js libraries managing. In order to use Bower on Windows, [msysgit](http://msysgit.github.io/) must be installed in a proper way - see Bower's [README.md](https://github.com/bower/bower#windows-users)

## Getting Started

If you plan to dive into the source, be sure to check out the [HACKING](https://github.com/ripple-emulator/ripple/blob/master/HACKING.md) 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](https://github.com/ripple-emulator/ripple/pulls)) into the `master` branch.

## Code Guidelines

* 4 spaces per editor tab.

* `jake lint`, no new lint errors introduced.

* All unit tests are green.

## Reference Material & Community

* [Project Site](https://github.com/ripple-emulator)