\n\n\n\n## Getting started\n\nThere's a [whole tutorial on getting started for beginners](https://serverjs.io/tutorials/getting-started/) but the quick version is to first install `server` as a dependency:\n\n```bash\nnpm install server\n```\n\n> Server requires **Node.js 7.6.0** or newer. **Node.js 8.x.y** LTS is recommended.\n\nThen you can create a file called `index.js` with this code:\n\n```js\n// Include the server in your file\nconst server = require('server');\nconst { get, post } = server.router;\n\n// Handle requests to the url \"/\" ( http://localhost:3000/ )\nserver([\n get('/', ctx => 'Hello world!')\n]);\n```\n\nExecute this in the terminal to get the server started:\n\n```bash\nnode .\n```\n\nAnd finally, open your browser on [localhost:3000](http://localhost:3000/) and you should see 'Hello world!' on your browser.\n\n\n\n## Documentation\n\nThe library is documented here:\n\nFull Documentation\n\n> [**Subscribe here**](http://eepurl.com/cGRggH) to receive tutorials when released. Tutorials are *good for learning* while the documentation is good for reference/quick use *once you know the basics*.\n\nYou can also download the repository and try the examples by browsing to them and `node .` inside each of them in `/examples`.\n\n\n\n## Use cases\n\nThe package `server` is great for many situations. Let's see some of them:\n\n\n### Small to medium projects\n\nEverything works out of the box, you get great support for most features and you can easily tap into Express' middleware ecosystem. What's not to love?\n\nSome of the included features: body and file parsers, cookies, sessions, websockets, Redis, gzip, favicon, csrf, SSL, etc. They just work so you will save a headache or two and can focus on your actual project. Get a simple form going:\n\n```js\nconst server = require('server');\nconst { get, post } = server.router;\nconst { render, redirect } = server.reply;\n\nserver(\n get('/', () => render('index.pug')),\n post('/', ctx => {\n console.log(ctx.data);\n return redirect('/');\n })\n);\n```\n\n\n\n### API design\n\nFrom the flexibility and expressivity of the bundle, designing APIs is a breeze:\n\n```js\n// books/router.js\nconst { get, post, put, del } = require('server/router');\nconst ctrl = require('./controller');\n\nmodule.exports = [\n get('/book', ctrl.list),\n get('/book/:id', ctrl.item),\n post('/book', ctrl.create),\n put('/book/:id', ctrl.update),\n del('/book/:id', ctrl.delete)\n];\n```\n\n\n\n### Real time\n\nWebsockets were never this easy to use! With socket.io on the front-end, you can simply do this in the back-end to handle those events:\n\n```js\n// chat/router.js\nconst { socket } = require('server/router');\nconst ctrl = require('./controller');\n\nmodule.exports = [\n socket('connect', ctrl.join),\n socket('message', ctrl.message),\n socket('disconnect', ctrl.leave)\n];\n```\n\n\n\n## Author & support\n\nThis package was created by [Francisco Presencia](http://francisco.io/) but hopefully developed and maintained by many others. See the [the list of contributors here](https://github.com/franciscop/server/graphs/contributors).\n\nI love using my work and I'm available for contractor work. Freelancing helps maintain `server` and [my other open source projects](https://github.com/franciscop/) up to date! I am also on [Codementor](https://www.codementor.io/franciscop) so if you want to learn more Javascript/Node.js/etc contact me there.\n\nYou can also [sponsor the project](https://serverjs.io/sponsor), get your logo in here and some other perks with tons of ♥\n","_attachments":{},"homepage":"https://serverjs.io/","bugs":{"url":"https://github.com/franciscop/server/issues"},"license":"MIT"}Simplicity is a great virtue but it requires hard work to achieve it and education to appreciate it. And to make matters worse: complexity sells better.
\n ― Edsger W. Dijkstra\n