How to open browser to localhost through npm scripts
This can be achieved by including a couple of additional packages in your project.
Additional packages
Install http-server:
$ npm install http-server --save-dev
and concurrently:
$ npm install concurrently --save-dev
npm scripts
Add the following open
script to package.json
:
"scripts": {
"start": "npm run open",
"open": "concurrently \"http-server -a localhost -p 1234\" \"open http://localhost:1234/build\""
}
Note
start
will actually be defined as follows to include the tasks you currently have:"start": "npm run build && npm run dev && npm run open",
The code in the
open
script above which reads:open http://localhost:1234/build
...assumes that the
build
task you have previously defined outputs aindex.html
to abuild
folder. If the file is named differently you will need to define it. E.g.open http://localhost:1234/build/the_html_file_name.html
You may need to add a delay between launching the server and opening the file, just to wait a bit til the server starts up. If that's the case then also install sleep-ms:
$ npm install sleep-ms --save-dev
and change the
open
script to:"open": "concurrently \"http-server -a localhost -p 1234\" \"sleepms 1000 && open http://localhost:1234/build\""
Cross platform
Unfortunately, the open command is not supported cross-platform. To overcome this issue check out opener or opn-cli and replace the command accordingly.
However, both packages, (opener
and opn-cli
), utilize Object.assign() so will not run in older versions of nodejs.
Edit: To open a browser window after starting the server, http-server
now accepts the -o
option . This can be utilized instead of either the opener
or opn-cli
packages.
For Webpack users: OpenBrowserPlugin does the trick too!
Install one dependency:
npm install open-browser-webpack-plugin --save-dev
And add this in webpack config file:
var OpenBrowserPlugin = require('open-browser-webpack-plugin');
...
plugins: [
new OpenBrowserPlugin({ url: 'http://localhost:3000' })
]
Update (may 2019)
Please note OpenBrowserPlugin is abandoned and a severe vulnerability hasn't been fixed for a while. However rodrigopandini has forked it here. Use npm install rodrigopandini/open-browser-webpack-plugin to use it.
Command to open URL (no extention or library needed) is:
"script_name": "start http://localhost:8080"
Put it with other commands:
"script_name": "set Node_ENV=development& start http://localhost:8080& nodemon app.js"
*NOTE: don't put it after node or nodemon command, otherwise it will not work.
Additional info:
It will open the URL in default browser.
First in browser it may show failed to load, because it takes some time for server to run. But it will refresh automatically when server will start if not then just refresh manually.
You just need:start http://localhost:1234
(I tested in Windows 10).
The scripts you need is :"open": "start http://localhost:1234"
But you should pay attention that, in Windows 10, you must place start http://localhost:1234
before your node.js server begins.