Articles

jsfiddle/togetherjs

Posted by admin

Qu’est-ce que TogetherJS?

TogetherJS est un service pour votre site Web qui facilite étonnamment la collaboration en temps réel.

En utilisant TogetherJS, deux personnes peuvent interagir sur la même page, voir les curseurs, les modifications et naviguer ensemble sur un site. Le service TogetherJS est inclus par le propriétaire du site Web, et un site Web peut personnaliser et configurer des aspects du comportement de TogetherJS sur le site.

Pour plus d’informations et pour voir TogetherJS en action, visitez togetherjs.com

Si vous souhaitez intégrer TogetherJS sur votre site, consultez le wiki et plus précisément la mise en route.

Contribution

Le reste de ce document concerne la contribution à TogetherJS – mais des rapports, des correctifs, des fonctionnalités, etc. Regardez ces autres liens si vous cherchez autre chose.

Rapports de bogues

Veuillez soumettre des rapports de bogues en tant que problèmes github. Ne vous inquiétez pas des étiquettes ou des jalons. Si vous utilisez les commentaires intégrés à l’application pour nous donner un rapport de bogue, c’est bien aussi.

Feuille de route & Plans

Pour voir ce que nous prévoyons ou au moins envisageons de faire avec TogetherJS, consultez notre outil de suivi des bogues.

Mise en place d’un environnement de développement

TogetherJS comporte deux éléments principaux:

  • Le serveur, qui renvoie des messages entre les utilisateurs. Le serveur ne fait pas grand-chose, vous pouvez regarder son histoire incroyablement ennuyeuse.

  • Le client en togetherjs/ qui fait tout le vrai travail.

Il y a un serveur hub TogetherJS déployé à https://hub.togetherjs.com – et il y a peu de besoin d’autres déploiements de serveur. Si vous souhaitez essayer TogetherJS, nous vous recommandons d’utiliser notre serveur hub. Remarque si vous incluez TogetherJS sur un site https, vous devez utiliser un serveur hub https.

Les fichiers doivent être légèrement « construits »: nous en utilisons MOINS pour les styles, et quelques fichiers sont générés. Pour développer, vous devez construire la bibliothèque en utilisant Grunt.

Pour créer une copie de la bibliothèque, consultez TogetherJS:

$ git clone git://github.com/mozilla/togetherjs.git$ cd togetherjs

Ensuite, installez npm et exécutez:

$ npm install$ npm install -g grunt-cli

Cela installera un tas de choses, dont la plupart ne sont utilisées que pour le développement. La seule dépendance « serveur » est WebSocket-Node (et si vous utilisez notre hub, vous n’avez pas à vous soucier du serveur). Par défaut, tout est installé localement, c’est-à-dire en node_modules/. Cela fonctionne très bien, mais il est utile d’installer globalement le programme de ligne de commande grunt, ce que npm install -g grunt-cli fait.

Maintenant, vous pouvez construire EnsembleJS, comme:

$ grunt build buildsite --no-hardlink

Cela créera une copie de l’ensemble du site togetherjs.com en build/. Vous devrez configurer votre propre serveur Web local pointé vers le répertoire build/. Pour démarrer un serveur sur le port 8080, exécutez:

$ node devserver.js

Si vous souhaitez développer avec TogetherJS, vous souhaitez probablement que les fichiers soient construits continuellement. Pour ce faire, utilisez:

$ grunt devwatch

Cela se reconstruira lorsque des modifications seront détectées. Notez que Grunt est configuré pour créer des liens physiques au lieu de copier afin que la plupart des modifications que vous apportez aux fichiers dans togetherjs/ n’aient pas besoin d’être reconstruites pour apparaître dans build/togetherjs/. --no-hardlink désactive ce comportement.

Vous pouvez créer une copie statique du client TogetherJS à distribuer et à utiliser sur votre site Web. Pour ce faire, exécutez:

$ grunt build --base-url https://myapp.com --no-hardlink --dest static-myapp

Ensuite, static-myapp/togetherjs.js et static-myapp/togetherjs-min.js seront en place, et le reste du code sera sous static-myapp/togetherjs/. Vous les déploieriez sur votre serveur.

Exécution d’un serveur local

Vous ne devriez pas avoir besoin d’exécuter votre propre version du serveur hub. Mais si vous souhaitez apporter des modifications au serveur, vous pouvez modifier hubURL par défaut en définissant la variable d’environnement HUB_URL lors de la construction. Exemple:

$ HUB_URL=http://localhost:8080 grunt devwatch

Testing

Les tests sont en togetherjs/tests/ — ce sont des doctest.tests js. Pour exécuter réellement les tests build togetherjs, servez-les et accédez à http://localhost:PORT/togetherjs/tests/ – à partir de là, les tests sont liés en haut de la page. Les tests réels sont *.js fichiers dans togetherjs/tests/, généralement test_*.js pour les tests unitaires et func_*.js pour les tests fonctionnels.

Le lien « Test manuel » vous permet de simuler différentes conditions dans TogetherJS sans configurer un deuxième navigateur / client.

Il n’y a malheureusement pas de coureur automatisé pour ces tests. Ce serait peut-être bien si le Karma pouvait être configuré avec doctest.js en général, mais jusqu’à présent, ce n’est pas fait.

Licence

Related Post

Leave A Comment