logoots-texteditor-server
v0.0.10
Published
Server-side application creating a data-structure representing a text and initializing a network to allow clients to edit the text and broadcast theirs changes in real-time
Downloads
4
Maintainers
Readme
TODO: Présentation du module
Installation
npm install logoots-texteditor-server
npm install socket.io
Utilisation
In your app.js file:
var server = require('http').createServer(app),
var Coordinator = require('logoots-texteditor-server').Coordinator,
var SocketIOAdapter = require('logoots-texteditor-server').SocketIOAdapter;
var coordinator = new Coordinator();
var socketIOAdapter = new SocketIOAdapter(server, coordinator);
coordinator.setNetwork(socketIOAdapter);
The network architecture provided consist in an central server communicating with clients using WebSockets, using socket.io, and broadcasting the modifications made by users to the others. If you don't want to use socket.io, you can easily implement your own network architecture, as long as you respect the name of the events and the data structure used to communicate between the coordinator and the network adapter.
See also
- logoots-structs
- logoots-texteditor-client
- demo-logoots-texteditor