Articles

jsfiddle / togetherjs

Posted by admin

Was ist TogetherJS?

TogetherJS ist ein Service für Ihre Website, der es überraschend einfach macht, in Echtzeit zusammenzuarbeiten.

Mit TogetherJS können zwei Personen auf derselben Seite interagieren, die Cursor des anderen sehen, Änderungen vornehmen und gemeinsam eine Site durchsuchen. Der TogetherJS-Dienst wird vom Websitebesitzer bereitgestellt, und eine Website kann Aspekte des Verhaltens von TogetherJS auf der Website anpassen und konfigurieren.

Für weitere Informationen und um TogetherJS in Aktion zu sehen, besuchen Sie togetherjs.com

Wenn Sie TogetherJS in Ihre Site integrieren möchten, lesen Sie das Wiki und speziell Erste Schritte.

Beitragen

Der Rest dieses Dokuments befasst sich mit dem Beitrag zu TogetherJS – aber mit Berichten, Korrekturen, Funktionen usw. Schauen Sie sich diese anderen Links an, wenn Sie nach etwas anderem suchen.

Fehlerberichte

Bitte senden Sie Fehlerberichte als Github-Probleme. Mach dir keine Sorgen über Etiketten oder Meilensteine. Wenn Sie das In-App-Feedback verwenden, um uns einen Fehlerbericht zu geben, ist das auch in Ordnung.

Roadmap & Pläne

Um zu sehen, was wir mit TogetherJS planen oder zumindest in Betracht ziehen, schauen Sie sich unseren Bug Tracker an.

Einrichten einer Entwicklungsumgebung

TogetherJS hat zwei Hauptteile:

  • Der Server, der Nachrichten zwischen Benutzern hin und her sendet. Der Server macht nicht viel, Sie können auf seine unglaublich langweilige Geschichte blicken.

  • Der Client in togetherjs/, der die ganze Arbeit erledigt.

Es gibt einen TogetherJS-Hub-Server, der unter https://hub.togetherjs.com bereitgestellt wird – und andere Serverbereitstellungen sind kaum erforderlich. Wenn Sie TogetherJS ausprobieren möchten, empfehlen wir Ihnen, unseren Hub-Server zu verwenden. Hinweis Wenn Sie TogetherJS auf einer https-Site einbinden, müssen Sie einen https-Hub-Server verwenden.

Die Dateien müssen leicht „gebaut“ werden: Wir verwenden WENIGER für Stile, und ein paar Dateien werden generiert. Um zu entwickeln, müssen Sie die Bibliothek mit Grunt erstellen.

Um eine Kopie der Bibliothek zu erstellen, schauen Sie sich TogetherJS an:

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

Installieren Sie dann npm und führen Sie es aus:

$ npm install$ npm install -g grunt-cli

Dadurch wird eine Reihe von Dingen installiert, von denen die meisten nur für die Entwicklung verwendet werden. Die einzige „Server“ -Abhängigkeit ist WebSocket-Node (und wenn Sie unseren Hub verwenden, müssen Sie sich keine Sorgen um den Server machen). Standardmäßig wird alles lokal installiert, dh in node_modules/. Dies funktioniert einwandfrei, aber es ist nützlich, das Befehlszeilenprogramm grunt global zu installieren, was npm install -g grunt-cli tut.

Jetzt können Sie TogetherJS bauen, wie:

$ grunt build buildsite --no-hardlink

Dadurch wird eine Kopie der gesamten togetherjs.com -Site in build/ erstellt. Sie müssen einen eigenen lokalen Webserver einrichten, der auf das Verzeichnis build/ verweist. Um einen Server an Port 8080 zu starten, führen Sie Folgendes aus:

$ node devserver.js

Wenn Sie mit TogetherJS entwickeln möchten, möchten Sie wahrscheinlich, dass die Dateien kontinuierlich erstellt werden. Um dies zu tun, verwenden Sie:

$ grunt devwatch

Dies wird neu erstellt, wenn Änderungen erkannt werden. Beachten Sie, dass Grunt so konfiguriert ist, dass harte Links erstellt werden, anstatt zu kopieren, sodass die meisten Änderungen, die Sie an Dateien in togetherjs/ vornehmen, nicht neu erstellt werden müssen, um in build/togetherjs/ angezeigt zu werden. --no-hardlink deaktiviert dieses Verhalten.

Möglicherweise möchten Sie eine statische Kopie des TogetherJS-Clients erstellen, die Sie auf Ihrer Website verteilen und verwenden können. Um dies zu tun, führen Sie:

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

Dann sind static-myapp/togetherjs.js und static-myapp/togetherjs-min.js vorhanden, und der Rest des Codes befindet sich unter static-myapp/togetherjs/. Sie würden diese auf Ihrem Server bereitstellen.

Ausführen eines lokalen Servers

Sie sollten keine eigene Version des Hub-Servers ausführen müssen. Wenn Sie jedoch Änderungen am Server vornehmen möchten, können Sie die Standard-hubURL ändern, indem Sie beim Erstellen die Umgebungsvariable HUB_URL festlegen. Beispielsweise:

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

Testen

Tests sind in togetherjs/tests/ – dies sind doctest.js-Tests. Um die Tests tatsächlich auszuführen, bauen Sie togetherjs auf, stellen Sie sie bereit und gehen Sie zu http://localhost:PORT/togetherjs/tests/ – von dort aus werden die Tests oben auf der Seite verlinkt. Die eigentlichen Tests sind *.js -Dateien in togetherjs/tests/, im Allgemeinen test_*.js für Unit-Style-Tests und func_*.js für Funktionstests.

Mit dem Link „Manuelles Testen“ können Sie verschiedene Bedingungen in TogetherJS simulieren, ohne einen zweiten Browser / Client einzurichten.

Für diese Tests gibt es leider keinen automatisierten Runner. Es wäre schön, wenn Karma mit doctest eingerichtet werden könnte.js im Allgemeinen, aber bisher ist das nicht getan.

Lizenz

Related Post

Leave A Comment