Das Desktop-Frontend für Klarschiff, einer Onlineplattform zum Melden und Bearbeiten von Problemen und Ideen, ist eine PHP-/HTML5-/JavaScript-Anwendung, basierend auf folgenden Frameworks und Bibliotheken:
- Bootstrap: HTML5-/CSS-JavaScript-Framework für responsives Web-Design
- jQuery: JavaScript-Framework
- OpenLayers 3: JavaScript-Mapping-Framework
- Proj4js: JavaScript-Bibliothek zur Transfomation von Koordinaten
Zur Installation werden Node.js >= 0.10 und npm benötigt. Letzteres wird in der Regel durch die Installation von Node.js bereitgestellt.
-
Anwendung aus dem Git-Repository klonen:
git clone https://github.com/rostock/klarschiff-frontend /Pfad/zum/Anwendungsverzeichnis -
gegebenenfalls Proxy für npm setzen:
npm config set proxy http://meine-proxy-domain:mein-proxy-port npm config set https-proxy http://meine-proxy-domain:mein-proxy-port -
notwendige Pakete sowie Tools via npm installieren:
npm install npm install -g grunt-cli -
in der Datei
Anwendungsverzeichnis/Gruntfile.jseinige lokale URL-Pfade anpassen, zum Beispielhttp://localhost/klarschiff_desktopaufhttp://localhost/web-server-pfad/zum/anwendungsverzeichnis -
Datei
Anwendungsverzeichnis/config/database.sample.phpkopieren alsAnwendungsverzeichnis/config/database.php -
referenzierte Bibliotheken installieren und einrichten via Grunt:
grunt install -
Die Tasks sind für zwei Umgebungen vorbereitet:
development: (Standardkonfiguration), die JavaScripte werden nur zusammengefasst, nicht komprimiert und es gibt einen Wachtdog, der bei Änderungen an den Quelldateien automatisch neue Builds für die Referenz in der Seite erstellt.production: Konfiguration viaGRUNT_ENV=production(ggf. in der/etc/environment). Die Scripte werden für eine bessere Performance zusätzlich komprimiert an den Browser ausgeliefert. Ein automatisierter Watchdienst ist bisher nicht konfiguriert.
-
Für beide Umgebungen wird der Standard-Tasks wie folgt aufgerufen:
grunt