Benutzeroberfläche für das IRPsim-Projekt

Initiale Einrichtung der Entwicklungumgebung

NPM ist der Node.js package manager. Dieses Werkzeug verwaltet die folgenden Werkzeuge (grunt, bower). Node.js muss entsprechend installiert sein.

Bower verwaltet Abhängigkeiten zu öffentlichen Projekten (z.B. JQuery, AngularJS, D3 ...)

Installation:

npm install -g bower

Grunt ist das Buildwerkzeug für Frontendprojekte (analog zu Make in C/C++, Ant in Java)

Installation:

npm install -g grunt-cli

Bauen des Projektes

Eigentliches Bauen des Projektes zur Entwicklungszeit:

npm install //installiere/aktualisiere alle Plugins für Grunt
bower install //installiere/aktualisiere alle Abhängigkeiten (TODO über Grunt automatisieren)
grunt default

Entwicklungszeit

Zur komfortablen Entwicklung gibt es

grunt serve

Dieser Befeht startet einen lokalen Webserver, öffnet die Anwendung im Browser und lädt die Seite automatisch neu nach jeder Änderung von Dateien des Projektes. Dabei wird davon ausgegangen, dass eine Instanz des Backendservers unter localhost:8282 verfügbar ist. Alle Anfragen an das Backend werden dahin umgeleitet.

Auslieferung

Wahlweise kann auch der finale Stand gebaut werden. Dabei werden CSS und Javascript minimiert und unleserlich gemacht (obfuscation):

grunt build-staging    // erstellt minimierte, optimierte Version für den Einsatz in QA
grunt build-production // erstellt minimierte, optimierte Version für den produktiven Einsatz

Zur Betrachtung der finalen, produktiven Version gibt es

grunt serve:dist --debug

Tests!

Tests werden auf Basis von Karma ausgeführt. Aus diesem Grund muss zur Ersteinrichtung der Karma Client installiert werden mittels

npm install -g karma-cli

Desweiteren muss Chrome auf dem PC installiert sein. Die Tests können mittels

grunt karma:unit

ausgeführt werden. Unter app/test befinden sich die Testklassen.

Licensing

This project is licensed under GPLv3.