JSPM

gulp-serve-iis-express

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q46758F
  • License MIT

Gulp package that will serve a site through IIS Express

Package Exports

  • gulp-serve-iis-express

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-serve-iis-express) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gulp-serve-iis-express

IIS Express server plugin for gulp. This repository is forked off of gulp-iis-express (not actively maintained) with necessary fixes and improvements.

Install

Install gulp-serve-iis-express as a development dependency:

npm install gulp-serve-iis-express --save-dev

Usage

Create a new task using gulp-serve-iis-express, which might look like below:

'use strict';

var gulp = require('gulp');
var iisexpress = require('gulp-serve-iis-express');

gulp.task('serve:site', function() {
    var configPath = path.join(__dirname, '..\\.vs\\config\\applicationHost.config');

    iisexpress({
        siteNames: ['site'],
        configFile: configPath
    });
});

Advanced Usage

Parameters

There are multiple parameters you can supply the object passed into the gulp-serve-iis-express variable:

configFile // Required (String) path to the config file.
siteNames // Required (String Array) array of site names.
appPath // Optional (String) application folder path.
port // Optional (Number) port number to serve the application. Defaults to 8080.
clrVersion // Optional (String) Version of clr.
sysTray // Optional (Boolean) Show the application in the system tray.
iisExpressPath // Optional (String) Path to IIS Express if different from programfiles (x86)

Additional Functionality

You can also call an additional function to launch the browser with a specified url after the server has been started. FYI, this is a work in progress currently and may not function correctly at the moment.

iisexpress.launchBrowser({
    startUrl: 'localhost:3000',
    browser: 'chrome',
    siteFile: 'index.html'
});

Contributing

Please open an issue first, then create a pull request with changes/additions linked to the issue.

License

MIT License