https://github.com/floatdrop/grid

Server for distributed WebRTC networking
https://github.com/floatdrop/grid

Last synced: about 1 month ago
JSON representation

Server for distributed WebRTC networking

• Host: GitHub
• URL: https://github.com/floatdrop/grid
• Owner: floatdrop
• Created: 2014-04-09T08:37:08.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-05-13T19:26:08.000Z (over 10 years ago)
• Last Synced: 2024-10-26T21:12:54.652Z (3 months ago)
• Language: JavaScript
• Size: 349 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Grid

[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url]

Grid - is signaling server for organizing distributed network over WebRTC protocol between browsers.

## Standalone server

```js

var grid = require('grid');

var server = grid({

    port: 8080

});

```

### Combining with existing express app

WebSocket server needs server instance to bootup, so we should create express app, then get server from `listen` method and only after that bind PeerServer to express application.

```javascript

var express = require('express');

var app = express();

var grid = require('grid');

app.get('/', function (req, res, next) { res.send('Hello world!'); });

var server = app.listen(8080);

app.use(grid({ server: server, path: '/api' }));

```

### API

Documentation on API coming soon.

[npm-url]: https://npmjs.org/package/grid

[npm-image]: http://img.shields.io/npm/v/grid.svg

[travis-url]: https://travis-ci.org/GridJS/grid

[travis-image]: http://img.shields.io/travis/GridJS/grid.svg

[depstat-url]: https://gemnasium.com/GridJS/grid

[depstat-image]: https://gemnasium.com/GridJS/grid.svg