https://github.com/g-rath/webpack-serve-overlay

Overlay for webpack-serve
https://github.com/g-rath/webpack-serve-overlay

Last synced: 9 days ago
JSON representation

Overlay for webpack-serve

• Host: GitHub
• URL: https://github.com/g-rath/webpack-serve-overlay
• Owner: G-Rath
• Created: 2018-06-29T22:03:54.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-02T04:03:14.000Z (about 6 years ago)
• Last Synced: 2024-10-11T10:16:46.322Z (25 days ago)
• Language: JavaScript
• Size: 30.3 KB
• Stars: 11
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# webpack-serve-overlay

A rudimentary overlay for [`webpack-serve`](https://github.com/webpack-contrib/webpack-serve), based off the one used in `webpack-dev-server`.

This package is targeted at serves as a quick fully functional way of 

being able to have the same overlay as `webpack-dev-server` in `webpack-serve` with minimal fuss & expense.

## Usage

Install the package:

```

npm i webpack-serve-overlay

```

Then require the overlay at the top of your `index.jsx` (or equivalent):

```javascript

// becomes dead code in builds other than dev,

// which webpack should pick up and remove.

if(process.env.NODE_ENV === 'development') {

    require('webpack-serve-overlay');

}

```

and you'll be away laughing.

## Configuration

The overlay works by using a WebSocket that connects to `webpack-serve` à la `webpack-hot-client`.  

This means that it *shouldn't* require any extra settings or configuration.

However, just in case, you can manually specify the WebSocket url by setting the `WEBPACK_SERVE_OVERLAY_WS_URL` env property.