gulp-server-livereload

Gulp plugin to run a local webserver with livereload enabled via socket.io

gulp-server-livereload

Gulp plugin to run a local webserver with live reload using socket.io

This is a fork of gulp-webserver. This version uses socket.io instead of tiny-lr so that the livereload mechanism works even if your browser does not support WebSockets (PhoneGap developers rejoice!).

It can also capture window.console output from the client-side and transmit it to the back-end for display. This is useful for when testing from Phonegap, etc.

$ npm install --save-dev gulp-server-livereload

The folder supplied to gulp.src() will be the root folder from which files will be served.

var gulp = require('gulp');
var server = require('gulp-server-livereload');
 
gulp.task('webserver', function() {
  gulp.src('app')
    .pipe(server({
      livereload: true,
      directoryListing: true,
      open: true
    }));
});

If you run gulp webserver your browser should automatically open up to http://localhost:8000 and show a directory listing of the app folder.

KeyTypeDefaultDescription
hostStringlocalhosthostname of the webserver
portNumber8000port of the webserver
livereloadBoolean/Objectfalsewhether to use livereload. For advanced options, provide an object. You can use the port property to set a custom live reload port (default is 35729).
directoryListingBoolean/Objectfalsewhether to display a directory listing. For advanced options, provide an object. You can use the path property to set a custom path or theoptions` property to set custom serve-index options.
defaultFileStringindex.htmldefault file to show when root URL is requested. If directoryListing is enabled then this gets disabled.
openBoolean/Objectfalseopen the localhost server in the browser
httpsBoolean/Objectfalsewhether to use https or not. By default, gulp-webserver provides you with a development certificate but you remain free to specify a path for your key and certificate by providing an object like this one: {key: 'path/to/key.pem', cert: 'path/to/cert.pem'}.
logStringinfoIf set to debug you will see all requests logged to the console.
clientConsoleBooleanfalsewhether to capture window.console output from the client and send it to the back-end for display.

Set 0.0.0.0 as the host option.

Set the defaultFile to main.html:

gulp.task('webserver', function() {
  gulp.src('app')
    .pipe(server({
      defaultFile: 'main.html'
    }));
});

MIT - see LICENSE.md