Skip to content
Serves a webpack app. Updates the browser on changes. Documentation https://webpack.js.org/configuration/dev-server/.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: add hiroppy to codeowners (#1670) Feb 19, 2019
bin fix: only add entries after compilers have been created (#1774) Apr 9, 2019
client-src feat: add sockPort option (#1792) Apr 16, 2019
examples chore(examples): add universal-config example (#1810) Apr 23, 2019
lib feat/addSockPath (#1804) Apr 19, 2019
ssl generate ssl certs per instance Jun 13, 2017
test feat/addSockPath (#1804) Apr 19, 2019
.babelrc chore(deps): update Babel to version7 (#1646) Feb 1, 2019
.editorconfig maint only mode Jan 5, 2018
.eslintignore cleanup client build setup Jan 10, 2018
.eslintrc
.gitattributes Fix inconsistencies in newlines at end of files Aug 31, 2016
.gitignore feat: add sockPort option (#1792) Apr 16, 2019
.prettierignore style: allow comma-dangle in eslintrc because compete with prettier (#… Feb 5, 2019
.prettierrc.js style: introduce prettier (#1647) Feb 4, 2019
.travis.yml ci: fix typo (#1672) Feb 19, 2019
CHANGELOG.md chore(release): 3.3.1 Apr 9, 2019
CONTRIBUTING.md docs(contribution): alternative way to test (#1506) Apr 9, 2019
LICENSE Update License to match with webpack/webpack Dec 7, 2016
README.md docs(readme): adds couple img shields and updates TOC (#1808) Apr 23, 2019
appveyor.yml ci: small improve (#1669) Feb 19, 2019
jest.config.js chore(jest): rename jest.config.json to jest.config.js (#1730) Mar 21, 2019
package-lock.json chore(deps): update dependency eslint-plugin-import to v2.17.1 (#1798) Apr 16, 2019
package.json chore(deps): update dependency eslint-plugin-import to v2.17.1 (#1798) Apr 16, 2019
renovate.json chore(renovate): update config Mar 11, 2019
setupTest.js chore: migrate on jest Feb 6, 2019

README.md

npm node deps tests coverage chat downloads contributors

webpack-dev-server

Use webpack with a development server that provides live reloading. This should be used for development only.

It uses webpack-dev-middleware under the hood, which provides fast in-memory access to the webpack assets.

Table of Contents

Getting Started

First things first, install the module:

npm install webpack-dev-server --save-dev

Note: While you can install and run webpack-dev-server globally, we recommend installing it locally. webpack-dev-server will always use a local installation over a global one.

Usage

There are two main, recommended methods of using the module:

With the CLI

The easiest way to use it is with the CLI. In the directory where your webpack.config.js is, run:

node_modules/.bin/webpack-dev-server

Note: Many CLI options are available with webpack-dev-server. Explore this link.

With NPM Scripts

NPM package.json scripts are a convenient and useful means to run locally installed binaries without having to be concerned about their full paths. Simply define a script as such:

"scripts": {
  "start:dev": "webpack-dev-server"
}

And run the following in your terminal/console:

npm run start:dev

NPM will automagically reference the binary in node_modules for you, and execute the file or command.

The Result

Either method will start a server instance and begin listening for connections from localhost on port 8080.

webpack-dev-server is configured by default to support live-reload of files as you edit your assets while the server is running.

See the documentation for more use cases and options.

Browser Support

While webpack-dev-server transpiles the client (browser) scripts to an ES5 state, the project only officially supports the last two versions of major browsers. We simply don't have the resources to support every whacky browser out there.

If you find a bug with an obscure / old browser, we would actively welcome a Pull Request to resolve the bug.

Support

We do our best to keep Issues in the repository focused on bugs, features, and needed modifications to the code for the module. Because of that, we ask users with general support, "how-to", or "why isn't this working" questions to try one of the other support channels that are available.

Your first-stop-shop for support for webpack-dev-server should by the excellent documentation for the module. If you see an opportunity for improvement of those docs, please head over to the webpack.js.org repo and open a pull request.

From there, we encourage users to visit the webpack Gitter chat and talk to the fine folks there. If your quest for answers comes up dry in chat, head over to StackOverflow and do a quick search or open a new question. Remember; It's always much easier to answer questions that include your webpack.config.js and relevant files!

If you're twitter-savvy you can tweet #webpack with your question and someone should be able to reach out and lend a hand.

If you have discovered a 🐛, have a feature suggestion, or would like to see a modification, please feel free to create an issue on Github. Note: The issue template isn't optional, so please be sure not to remove it, and please fill it out completely.

Contributing

We welcome your contributions! Please have a read of CONTRIBUTING.md for more information on how to get involved.

Attribution

This project is heavily inspired by peerigon/nof5.

License

MIT

You can’t perform that action at this time.