jetpad

Jetpad

Jetpad est un éditeur de texte collaboratif basé sur le Web construit avec Swellrt en temps réel et le framework Angular 2.

Installation

Installez le gestionnaire de packages Node.js et NPM afin de télécharger les dépendances. Ensuite, faites:

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

Courir

Vous pouvez l'exécuter en mode Dev avec:

 npm start

Le serveur s'exécute maintenant sur http: // localhost: 3000 /

Construire

Si vous souhaitez construire le projet en mode Dev, faites:

 npm run build

Pour la construction de la production, faites: faire:

 npm run build:prod

Les fichiers de sortie seront placés dans le dossier '/ dist'.

Serveur swellrt

Jetpad nécessite Swellrt en tant que serveur backend. Pour configurer un serveur Swellrt, veuillez visiter le Swellrt Readme.

Si vous exécutez Jetpad en mode Dev ( npm start ), le fichier index index.html pointera vers localhost:9898 , le point de terminaison de développement Swellrt par défaut. Pour d'autres scénarios, modifiez index.html pour ajuster le point de terminaison à swellrt.js .

Nginx

Lorsque vous utilisez Nginx comme serveur frontal pour Jetpad, utilisez correctement la configuration suivante pour mettre en cache les ressources:

 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;
        }
}

Dépendances

Jetpad utilise WebPack 2. Afin de gérer les dépendances du projet, vous devez utiliser le système NPM ou ajouter directement la nouvelle dépendance dans Package.json Fichier:

  npm install <dependency> --save

La disposition du projet est basée dans le démarreur AngularClass. La configuration est hébergée complètement sous le dossier config du projet. Il existe trois types de configuration: dev , prod et test . Il existe également une configuration pour les tests unitaires gérés par les tests Karma et E2E basés dans le rapporteur.

Amorce

Le projet utilise Bootstrap comme cadre d'interface utilisateur. La version actuelle est 3.3.7. Le projet utilise également les modules bootstrap-material-conception et le module bootstrap-sass.

Bootstrap nécessite également jQuery . La version importée avec le projet est 1.9.1. Les styles SASS sont définis dans le dossier src/assets et le fichier principal est src/app/app.style.scss .

Actuellement, le projet n'implémente pas les composants angulaires en tant que composants Web. La configuration dans app .......... combgeant principale de l'application configure la propriété d'encapsulation en tant encapsulation: ViewEncapsulation.None . De cette façon, toutes les systèmes définis seront apparentes dans des éléments de style dans la tête de l'application. La transformation des styles SASS en CSS pur est constituée par des chargeurs WebPack: CSS-chargedeur, CSS-to-string-chargedeur, résolve-url et sass-chargedeur.

Copyright et licence

Code et documentation Copyright 2016-2017 Pablo Ojanguren, David Llop, Alejandro Garrido et University Complutense of Madrid. Code publié sous la licence Affero GPL V3. DOC sous licence sous CC par 4.0.