Skip to content
🖥️ Simple and powerful server for Node.js
JavaScript HTML
Branch: master
Clone or download

Latest commit

Latest commit c8a408a Mar 10, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Added workflow Feb 16, 2020
docs Update index.html Mar 10, 2020
error Improved testing and added better internal error handling Dec 24, 2017
examples Added socket.io options and fixed testing Feb 18, 2020
plugins Fixed path for sockett Feb 18, 2020
reply Added session to the sockets. Fixed test and docs for jsonp Jan 1, 2018
router Updated documentation and added test for matching the error by path. … Jan 24, 2018
src Normalized folders Jan 9, 2018
test Updated test Mar 22, 2018
.env.demo Added socket.io options and fixed testing Feb 18, 2020
.eslintrc.json Added eslint and migrated to the Reply methods. Fixes #11. New alpha … May 28, 2017
.gitignore
.npmignore Fixed all tests and prepared for Beta 2 Aug 27, 2017
Contributing.md Improved contributing, added plugin log and added sponsors Mar 22, 2017
Gruntfile.js Upgraded grunt to use node-sass Feb 16, 2020
LICENSE Reinitialized it to make git smaller Mar 10, 2017
README.md Github badge Feb 18, 2020
api.js Added initial specification for the stable release Jun 5, 2017
appveyor.yml Upgraded Jest Oct 18, 2019
changelog.md Added the security incident report link and changelog Feb 16, 2018
circle.yml Large refactoring Jun 2, 2017
package.json 1.0.27 Feb 26, 2020
roadmap.md Large refactoring Jun 2, 2017
server.js Added session to the sockets. Fixed test and docs for jsonp Jan 1, 2018

README.md

server.js for Node.js

Subscribe Downloads Status Windows Build Dependencies status

Powerful server for Node.js that just works so you can focus on your awesome project:

// Include it and extract some methods for convenience
const server = require('server');
const { get, post } = server.router;

// Launch server with options and a couple of routes
server({ port: 8080 }, [
  get('/', ctx => 'Hello world'),
  post('/', ctx => {
    console.log(ctx.data);
    return 'ok';
  })
]);

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.

― Edsger W. Dijkstra

Getting started

There's a whole tutorial on getting started for beginners but the quick version is to first install server as a dependency:

npm install server

Server requires Node.js 7.6.0 or newer. Node.js 8.x.y LTS is recommended.

Then you can create a file called index.js with this code:

// Include the server in your file
const server = require('server');
const { get, post } = server.router;

// Handle requests to the url "/" ( http://localhost:3000/ )
server([
  get('/', ctx => 'Hello world!')
]);

Execute this in the terminal to get the server started:

node .

And finally, open your browser on localhost:3000 and you should see 'Hello world!' on your browser.

Documentation

The library is documented here:

Full Documentation

Subscribe here to receive tutorials when released. Tutorials are good for learning while the documentation is good for reference/quick use once you know the basics.

You can also download the repository and try the examples by browsing to them and node . inside each of them in /examples.

Use cases

The package server is great for many situations. Let's see some of them:

Small to medium projects

Everything 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?

Some 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:

const server = require('server');
const { get, post } = server.router;
const { render, redirect } = server.reply;

server(
  get('/', () => render('index.pug')),
  post('/', ctx => {
    console.log(ctx.data);
    return redirect('/');
  })
);

API design

From the flexibility and expressivity of the bundle, designing APIs is a breeze:

// books/router.js
const { get, post, put, del } = require('server/router');
const ctrl = require('./controller');

module.exports = [
  get('/book', ctrl.list),
  get('/book/:id', ctrl.item),
  post('/book', ctrl.create),
  put('/book/:id', ctrl.update),
  del('/book/:id', ctrl.delete)
];

Real time

Websockets 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:

// chat/router.js
const { socket } = require('server/router');
const ctrl = require('./controller');

module.exports = [
  socket('connect', ctrl.join),
  socket('message', ctrl.message),
  socket('disconnect', ctrl.leave)
];

Author & support

This package was created by Francisco Presencia but hopefully developed and maintained by many others. See the the list of contributors here.

I love using my work and I'm available for contractor work. Freelancing helps maintain server and my other open source projects up to date! I am also on Codementor so if you want to learn more Javascript/Node.js/etc contact me there.

You can also sponsor the project, get your logo in here and some other perks with tons of

You can’t perform that action at this time.