jetpad

Jetpad

JETPAD ist ein webbasierter kollaborativer Texteditor, der mit SwellRT-Echtzeit-Technologie und dem Angular 2-Framework erstellt wurde.

Installation

Installieren Sie Node.js und NPM Paket Manager, um die Abhängigkeiten herunterzuladen. Dann tun Sie:

 git clone [email protected]:P2Pvalue/jetpad.git
cd jetpad
npm i

Laufen

Sie können es im Dev -Modus ausführen mit:

 npm start

Der Server wird jetzt unter http: // localhost: 3000/ausgeführt

Bauen

Wenn Sie das Projekt im Dev -Modus erstellen möchten, tun Sie:

 npm run build

Für die Produktionsbereitschaft, tun Sie:

 npm run build:prod

Ausgabedateien werden im Ordner '/dist' platziert.

Swellrt -Server

JETPAD benötigt SwellRT als Backend -Server. Um einen SwellRT -Server einzurichten, besuchen Sie bitte die SwellRT Readme.

Wenn Sie JETPAD im Dev -Modus ( npm start ) ausführen, verweist der Indexdatei index.html auf localhost:9898 , den Standard -SwellRT -Entwicklungsendpunkt. Für andere Szenarien bearbeiten index.html , um den Endpunkt an swellrt.js anzupassen.

Nginx

Verwenden Sie bei Verwendung von Nginx als Fronted Server für JETPAD die folgende Konfiguration, um die Ressourcen ordnungsgemäß zu Cache:

 server {
        listen 80;
        listen [::]:80;

        server_name     jetpad.local.net;

        root /var/www/jetpad;
        index index.html;

        location / {
                try_files $uri$args $uri$args/ $uri/ /index.html =404;
                add_header Cache-Control must-revalidate;
        }

        location /assets {
                etag on;        
        }

        location ~ .bundle.js$ {
                add_header Cache-Control public;
                etag off;
                expires max;
                gzip on;
                gzip_types application/javascript;
        }
}

Abhängigkeiten

JETPAD verwendet Webpack 2. Um Projektabhängigkeiten zu verwalten, sollten Sie das NPM -System verwenden oder direkt die neue Abhängigkeit in Paket.json -Datei hinzufügen:

  npm install <dependency> --save

Das Layout des Projekts basiert auf AngularClass Starter. Die Konfiguration wird vollständig im config des Projekts gehostet. Es gibt drei Arten von Konfiguration: Dev , Prod und Test . Außerdem gibt es eine Konfiguration für Unit -Tests, die von Karma- und E2E -Tests basierend auf dem Prospraktor verwaltet wird.

Bootstrap

Das Projekt verwendet Bootstrap als UI -Framework. Die aktuelle Version ist 3.3.7. Das Projekt verwendet auch das Bootstrap-Materials-Design-Module und das Bootstrap-Sass-Modul.

Bootstrap benötigt auch JQuery . Die mit dem Projekt importierte Version ist 1.9.1. Die Sass -Stile sind im Ordner src/assets definiert und die Hauptdatei ist src/app/app.style.scss .

Derzeit implementiert das Projekt keine Winkelkomponenten als Webkomponenten. Die Konfiguration in app.comPonent.ts , Hauptkomponente der Anwendung Die Kapselungseigenschaft als encapsulation: ViewEncapsulation.None . Auf diese Weise werden alle definierten Sytles in Stilelementen im Kopf der Anwendung vorbereitet. Die Transformation von Sass-Stilen in reine CSS wird aus Webpackladern zusammengesetzt: CSS-Lader, CSS-to-String-Lader, Resolve-URL und Sass-Loader.

Urheberrecht und Lizenz

Code und Dokumentation Copyright 2016-2017 Pablo Ojanguren, David Llop, Alejandro Garrido und Universitätskombination von Madrid. Code, der unter der Lizenz Affero GPL V3 veröffentlicht wurde. DOC lizenziert unter CC um 4.0.