rollup-plugin-serve-proxy

Serve your rolled up bundle

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
rollup-plugin-serve-proxy
1.1.45 years ago5 years agoMinified + gzip package size for rollup-plugin-serve-proxy in KB

Readme

Rollup plugin to serve the bundle
Software License Issues JavaScript Style Guide NPM Latest Version

Installation

# Rollup v0.60+ and v1+
npm install --save-dev rollup-plugin-serve-proxy

Authorship

This package is a fork of Thomas Ghysels' excellent rollup-plugin-serve. This fork also includes code needed to route calls to a separate CORS-enabled backend.

Usage

// rollup.config.js
import serve from 'rollup-plugin-serve'

export default {
  input: 'src/main.js',
  output: {
    file: 'dist/bundle.js',
    format: ...
  },
  plugins: [
    serve('dist')
  ]
}

Options

By default it serves the current project folder. Change it by passing a string:
serve('public')    // will be used as contentBase

// Default options
serve({
  // Launch in browser (default: false)
  open: true,

  // Page to navigate to when opening the browser.
  // Will not do anything if open=false.
  // Remember to start with a slash.
  openPage: '/different/page',

  // Show server address in console (default: true)
  verbose: false,

  // Folder to serve files from
  contentBase: '',

  // Multiple folders to serve from
  contentBase: ['dist', 'static'],

  // Set to true to return index.html (200) instead of error page (404)
  historyApiFallback: false,

  // Path to fallback page
  historyApiFallback: '/200.html',

  // Options used in setting up server
  host: 'localhost',
  port: 10001,

  // By default server will be served over HTTP (https: false). It can optionally be served over HTTPS
  https: {
    key: fs.readFileSync('/path/to/server.key'),
    cert: fs.readFileSync('/path/to/server.crt'),
    ca: fs.readFileSync('/path/to/ca.pem')
  },

  //set headers
  headers: {
    'Access-Control-Allow-Origin': '*',
    foo: 'bar'
  },

  // Set up simple proxy
  // this will route all traffic starting with
  // `/api` to http://localhost:8181/api
  proxy: {
    api: 'http://localhost:8181'
  }
})

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Contributions and feedback are very welcome.
This project aims to stay lean and close to standards. New features should encourage to stick to standards. Options that match the behaviour of webpack-dev-server are always ok.
To get it running: 1. Clone the project. 2. npm install 3. npm run build

Credits

License

The MIT License (MIT). Please see License File for more information.