Skip to content

briancw/boostjs-server

Repository files navigation

BoostJS 🚀 serverside by Clever.ly

BoostJS is an opinionated framework designed to make responsive data easy and efficient. This is a nodejs serverside implementation which provides efficient data publishing over websockets. BoostJS currently only supports RethinkDB.

Implementing Boost is currently not easy. Following this sample project is probably the easiest way to get started. https://github.com/briancw/boost-sample-project

npm install boostjs-server

const BoostServer = require('boostjs-server');
const boost = new BoostServer({
    spdy: {
        protocols: ['http/1.1'],
        plain: true,
    },
});
const port = 3000;
const app = boost.app;
app.get('/', function(req, res) {
    res.send('It Works!');
});
boost.launch(port, err => {
    console.log('Listening on port ' + port);
});

Notable Npm Modules

Core:

  • thinky: RethinkDB ORM
  • socket.io: socket connections between server and client with multiplexing, fallbacks, auto-reconnect, and other useful features

Project Requirements

This project requires Rethinkdb to be installed on your machine https://www.rethinkdb.com/docs/install/

Additionally, you will need node and npm. Current recommend version is 6.x

Development Guide Project Todos

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •