Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 2.53 KB

README.md

File metadata and controls

54 lines (42 loc) · 2.53 KB
Raw

surge-logo Surge is a lightweight "framework" for SockJS, providing an API on top of it, adding extra features. If you come from socket.io like i did, you will find it easier to adjust with SockJS using Surge.

This project consists of

You can use surge-client without having your own surge-server.

##How to install

You need to have installed nodejs. Clone this repo to your machine and run

npm install

You will also need to change your IP and port at app.js

server.listen(8080, '0.0.0.0');

##Run

Run nodemon with :

npm start

If you want to keep your remote machine up and running, i recommend using pm2. You should also configure it to run on startup in case of server restarting for any reason.

Dont forget to use your server ip/domain as a host in surge-client

##Features

  • Blazing fast to set up.
  • Auto-reconnecting already enabled (also reconnects to previously connected rooms)
  • Smaller learning curve if you come from socket.io and you want to use some of its features heads on with the SockJS API
  • If the socket gets disconnected all further emits will go to a buffer. Upon reconnection the events will fire with the same series that they were called
  • I will be maintaining this library since i will be using it on production
  • Open source! Want to change something? Fork it change it , do a pull request or don't and keep it for yourself
  • Check roadmap for more!

##Roadmap

  • Authenticating connection requests using a token/secret hmac
  • Add authentication endpoint option for Authenticating users on the socket
  • Introduce Private - Preservance Channels after authenticating users
  • Build an interface for main Surge server to register developers/apps generate keys and show usage stats for every app
  • Add support for persisting users using cookie-based session
  • Use redis to scale surge servers behind a HAProxy load balancer and provide a more production-ready library

##Contributions I will be maintaining this project since i will be using it in production for my apps, but if you want to help out filling the issue tracker or helping with the code, feel free to contact me or do a pull request

##Licence MIT