Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    grunt-ripple-emulatorpublic

    grunt-ripple-emulator

    Grunt task for the ripple emulator for Cordova/PhoneGap projects.

    Getting Started

    This plugin requires Grunt ~0.4.0

    If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

    npm install grunt-ripple-emulator --save-dev

    Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

    grunt.loadNpmTasks('grunt-ripple-emulator');

    The "ripple_emulator" task

    Overview

    In your project's Gruntfile, add a section named ripple to the data object passed into grunt.initConfig().

    grunt.initConfig({
      ripple: {
        options: {
          // Task-specific options go here.
        },
        your_target: {
          // Target-specific file lists and/or options go here.
        },
      },
    })

    Options

    options.path

    Type: String Default value: 'www'

    Path to your your Cordova / PhoneGap's main www directory (relative to your Gruntfile).

    options.port

    Type: Integer Default value: 4400

    Port that ripple will server your application on.

    options.open

    Type: Boolean Default value: true

    If true opens your app in the browser with ripple enabled.

    options.keepAlive

    Type: Boolean Default value: false

    If true the task will keep running (keep your ripple server running).

    NOTE If you are using grunt-contrib-watch (or something similar) then you'll want to set keepAlive: false.

    Usage Examples

    Serve the application from dist folder on port 9005 and keep the ripple server running.

    grunt.initConfig({
      ripple: {
        options: {
            path: 'dist',
            port: '9005',
            keepAlive: true
        }
      },
    })

    Contributing

    In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

    Release History

    v0.1.0 - Initial release

    Keywords

    none

    install

    npm i grunt-ripple-emulator

    Downloadsweekly downloads

    1

    version

    0.1.0

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar