Desktop-Frontend für Klarschiff, einer Onlineplattform zum Melden und Bearbeiten von Problemen und Ideen
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
frontend
images
javascripts
php
search
styles
templates
.gitignore
Gruntfile.js
LICENSE
README.md
api.php
datenschutz.php
favicon.ico
georss.php
header.inc.php
hilfe.php
impressum.php
index.php
map.php
nutzungsbedingungen.php
package.json
rss.php

README.md

Desktop-Frontend für Klarschiff

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

Installation

Voraussetzungen

Zur Installation werden Node.js >= 0.10 und npm benötigt. Letzteres wird in der Regel durch die Installation von Node.js bereitgestellt.

Installation

  1. Anwendung aus dem Git-Repository klonen:

    git clone https://github.com/rostock/klarschiff-frontend /Pfad/zum/Anwendungsverzeichnis
    
  2. 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
    
  3. notwendige Pakete sowie Tools via npm installieren:

    npm install
    npm install -g grunt-cli
    
  4. in der Datei Anwendungsverzeichnis/Gruntfile.js einige lokale URL-Pfade anpassen, zum Beispiel http://localhost/klarschiff_desktop auf http://localhost/web-server-pfad/zum/anwendungsverzeichnis

  5. Datei Anwendungsverzeichnis/config/database.sample.php kopieren als Anwendungsverzeichnis/config/database.php

  6. referenzierte Bibliotheken installieren und einrichten via Grunt:

    grunt install
    
  7. Die Tasks sind für zwei Umgebungen vorbereitet:

    1. 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.
    2. production: Konfiguration via GRUNT_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.
  8. Für beide Umgebungen wird der Standard-Tasks wie folgt aufgerufen:

     grunt