https://github.com/phonegap/connect-phonegap

Stream a PhoneGap app to any device.
https://github.com/phonegap/connect-phonegap

Last synced: 11 months ago
JSON representation

Stream a PhoneGap app to any device.

• Host: GitHub
• URL: https://github.com/phonegap/connect-phonegap
• Owner: phonegap
• License: apache-2.0
• Created: 2013-12-10T00:06:46.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T08:07:00.000Z (over 3 years ago)
• Last Synced: 2025-03-31T09:07:47.509Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 7.36 MB
• Stars: 61
• Watchers: 17
• Forks: 60
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# connect-phonegap 

[![Build Status][travis-ci-img]][travis-ci-url] 

[![codecov](https://codecov.io/gh/phonegap/connect-phonegap/branch/master/graph/badge.svg)](https://codecov.io/gh/phonegap/connect-phonegap)

> Connect middleware to serve a PhoneGap app.

## What is it?

  A fine question for an even finer middleware. `connect-phonegap` is a server that runs on your development machine (typically through the `phonegap-cli`) and serves your PhoneGap app to the accompanying PhoneGap Developer App. `connect-phonegap` does this by watching your PhoneGap project and first sends a zip of the www/ to your app. When you update your project, the differences are then sent to your connected phone to display updates.

  To note: when the server sends content to your phone, the server is also injecting js inline into the .html pages. The injected scripts are for detecting changes on the server, logging, handling three/four finger taps, etc. Sometimes this may interfere with your own js code that you may write. Therefore, we have options in order to toggle these scripts.

## Examples

### Standalone

    var pgConnect = require('connect-phonegap');

    pgConnect.listen();

### Express

    var pgConnect = require('connect-phonegap'),

        express = require('express'),

        app = express();

    app.use(pgConnect());

    app.listen(3000);

### Connect

    var pgConnect = require('connect-phonegap'),

        connect = require('connect'),

        app = connect();

    app.use(pgConnect());

    app.listen(3000);

### HTTP

    var pgConnect = require('connect-phonegap'),

        http = require('http');

    var server = http.createServer(pgConnect());

    server.listen(3000);

## API

    var pgConnect = require('connect-phonegap');

### pgConnect()

Options:

  - `[options]` {Object}

  - `[autoreload]` {Boolean} toggle AutoReload watch (default: true).

  - `[localtunnel]` {Boolean} toggle localtunnel (default: false).

  - `[console]` {Boolean} toggle console logging injection script - allows logs to be appears on your terminal(default: true).

  - `[deploy]` {Boolean} toggle deploy injection script - allows zips to be unzipped and deployed when sent to the client (default: true).

  - `[homepage]` {Boolean} toggle homepage injection script - allows the ability to three finger tap back to the landing page of the PhoneGap Developer App (default: true).

  - `[proxy]` {Boolean} toggle proxy injection script - for previewing the app from browser. Allows cors requests to be proxy'd through the server (default: true).

  - `[push]` {Boolean} toggle push injection script - allows push notifications to be used within the PhoneGap Developer App (default: true).

  - `[refresh]` {Boolean} toggle refresh injection script - allows four finger tap to hard refresh your app (default: true).

Events:

  - `error` is emitted when an error occurs.

  - `log` is emitted with log info.

  - `deviceConnected` is emitted whenever a new device connects to the server.

Return:

  - {Function} request listener that can be provided to `http.Server` or

    used as `connect` middleware.

Example:

    var pgConnect = require('connect-phonegap')(),

        middleware = pgConnect();

    // subscribe to events

    middleware.on('log', function() {

        console.log.apply(this, arguments);

    });

    // use as middleware

    app.use(middleware);

    // or

    // use as request listener

    http.createServer(middleware).listen(3000);

### pgConnect.listen(options, [callback])

### pgConnect.serve(options, [callback])

Creates a local server to serve up the project. The intended

receiver is the PhoneGap App but any browser can consume the

content.

Options:

  - `[options]`

    - `[port]` {Number} to listen on (Default: 3000).

    - all options available to phonegap() middleware.

Events:

  - `complete` is triggered when server starts.

    - `data` {Object}

      - `server` {http.Server} is the server running.

      - `address` {String} is the server address.

      - `port` {Number} is the server port.

  - `error` trigger when there is an error with the server or request.

    - `e` {Error} is null unless there is an error.

  - all events available to phonegap() middleware.

  - all events available to `http.Server`

Return:

  - {http.Server} instance that is also an event emitter.

Example:

    pgConnect.listen()

            .on('complete', function(data) {

                // server is now running

            })

            .on('error', function(e) {

                // an error occured

            });

    });

[travis-ci-img]: https://travis-ci.org/phonegap/connect-phonegap.svg?branch=master

[travis-ci-url]: http://travis-ci.org/phonegap/connect-phonegap