0.0.6 • Published 10 years ago

logoots-texteditor-client v0.0.6

Weekly downloads
-
License
ISC
Repository
-
Last release
10 years ago

TODO: Présentation du module

Installation

In your client-side js folder

npm install logoots-texteditor-client

If you don't have already install browserify

npm install -g browserify

Then:

grunt

Don't forget to download Ace (http://ace.c9.io/#nav=about) and to extract it in your client-side folder as well as to install socket.io in your server-side folder.

Utilisation

In your HTML file:

<script src="path/js/logoots-texteditor-client/build/logoots-texteditor-client.js"></script>
<script src="path/js/ace/src-noconflict/ace.js"></script>
<script src="/socket.io/socket.io.js"></script>
<script>
	"use strict";
    var coordinator = new LogootS.Coordinator();
    console.log(coordinator);
    var editor = new LogootS.AceEditorAdapter('editor', coordinator);
    coordinator.setEditor(editor);
    var network = new LogootS.SocketIOAdapter(coordinator);
    coordinator.setNetwork(network);
</script>

Network

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. 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.

Text Editor

This module implement an adapter to allow the coordinator to communicate with the code editor Ace. Like the network adapter, you can also implement your own to

See also

  • logoots-structs
  • logoots-texteditor-client
  • demo-logoots-texteditor