ripple-emulator/doc/cli/emulate.md

A browser based html5 mobile application development and testing tool

<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#  KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#
-->

# Synopsis

    ripple emulate [--port xxxx] [--path xxxx] [--remote xxxx] [--route xxxx]

# Description

    Boot a ripple server instance to test your application on. This will
    do various things, such as statically host your app, and bind any
    ripple services (xhr proxy, etc) to a specific route (see --route).

# Arguments

* --port    the port to host the application on (defaults to 4400)
* --path    app path to statically serve for testing (if omitted, the current working directory will be used)
* --remote  instead of a (local) --path, you can specify a remote website to load (via proxy) and emulate
* --route   specify the URL path on which ripple services will run (defaults to '/ripple') example: http://localhost:1234/ripple/xhr_proxy

# Example usage

    ripple emulate --port 1234 --path path/to/my/application/root

    ripple emulate --remote http://google.com