\n
![](\"https://d26dzxoao6i3hh.cloudfront.net/items/36410M2p1j2T322w0Q2g/Screen%20Recording%202017-08-18%20at%2011.24%20pm.gif?v=35e385d1\")
\n \n
\n
\n \n
\n
![](\"https://img.shields.io/github/tag/Kikobeats/svr.svg?style=flat-square\")
\n![](\"https://img.shields.io/travis/Kikobeats/svr/master.svg?style=flat-square\")
\n![](\"https://img.shields.io/coveralls/Kikobeats/svr.svg?style=flat-square\")
\n![](\"https://img.shields.io/david/Kikobeats/svr.svg?style=flat-square\")
\n![](\"https://img.shields.io/david/dev/Kikobeats/svr.svg?style=flat-square\")
\n![](\"https://img.shields.io/npm/dm/svr.svg?style=flat-square\")
\n![](\"https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square\"){kind=icon}
\n\nHot Module replacement (HMR) capabilities for any HTTP Server.
\n
It's similar micro-dev, but out of the box for any framework that use http.Server.listen() interface.
\n$ npm install svr --save-dev
The only requirement is define the main file of your server as exported function that follow this interface:
\nmodule.exports = (app, express) => {\n/* your awesome code here */\n}
This could be a good start point for a HTTP server:
\nconst isProduction = process.env.NODE_ENV === 'production'\n\nmodule.exports = (app, express) => {\n /* here you can do whatever you want */\n app\n .use(require('helmet')())\n .use(require('compression')())\n .use(require('cors')())\n .use(require('jsendp')())\n .use(require('express-status-monitor')())\n .use(bodyParser.urlencoded({ extended: true }))\n .use(bodyParser.json())\n .use(require('morgan')(isProduction ? 'combined' : 'dev'))\n .use(express.static('static'))\n .disable('x-powered-by')\n\n app.get('/', async function (req, res) {\n return res.send('hello world')\n })\n\n return app\n}
After that, you need to call svr. We recommend add svr as npm script:
{\n "scripts": {\n "dev": "srv"\n }\n}Running npm run dev you start your HRM development server:
$ npm start\n\n ┌───────────────────────────────────────────────────┐\n │ │\n │ my-express-api is running! │\n │ │\n │ • Local: http://localhost:3000 │\n │ • On Your Network: http://192.168.1.106:3000 │\n │ │\n └───────────────────────────────────────────────────┘
svr it's assuming main file is called index.js in the current path. Otherwise, you can provide the file path as first argument.
Now whatever file modification in the current directory is listened by the svr automagically:
┌───────────────────────────────────────────────────┐\n │ │\n │ my-express-api is running! │\n │ │\n │ • Local: http://localhost:3000 │\n │ • On Your Network: http://192.168.1.106:3000 │\n │ │\n └───────────────────────────────────────────────────┘\n\n ℹ 18:32:42 modified index.js
It takes in consideration your .gitignore files, so it only will reload the right files.
Using svr --watch you can add more files to be watched, but you need to reload the server in any time, just type rs:
┌───────────────────────────────────────────────────┐\n │ │\n │ my-express-api is running! │\n │ │\n │ • Local: http://localhost:3000 │\n │ • On Your Network: http://192.168.1.106:3000 │\n │ │\n └───────────────────────────────────────────────────┘\n\n ℹ 18:32:42 modified index.js\n rs\n ℹ 18:34:07 restart index.js
svr is oriented for development scenario.
Under production, simply create the boostraping server that you need.
\nFor example, you can take this server.js as production server:
\n\nconst express = require('express')\n\nconst app = express()\n\nrequire('./index')(app, express)\n\nconst port = process.env.PORT || process.env.port || 3000\nconst { name } = require('../package.json')\n\napp.listen(port, function () {\n console.log(`${name} is running at http://localhost:${port}`)\n})
Just add it as npm start script
{\n "scripts": {\n "start": "node server.js"\n }\n}That's all. You're taking the best of the two worlds: Developer Experience for development and tiny bundle for production.
\nMIT © Kiko Beats.
\n" + }, + { + "component": "footer", + "links": [ + { + "href": "https://github.com/Kikobeats/svr", + "text": "GitHub" + }, + { + "href": "https://github.com/Kikobeats", + "text": "Kikobeats" + } + ] + } + ] +} \ No newline at end of file