Klarschiff-Backoffice

CitySDK API

Die Anwendung stellt eine CitySDK API inkl. zusätzlicher Erweiterungen bereit.

Installation

Voraussetzungen

• RVM / oder andere Rubyversionsverwaltung

  • Installation von RVM (kann übersprungen werden wenn diese bereits erfolgt ist):

    \curl -L https://get.rvm.io | sudo bash -s stable --ruby

  • Aktualisierung von RVM (falls es bereits systemweit installiert ist)

    rvmsudo rvm get stable

• Passenger-Apache-Modul installieren: Hierzu am besten der offiziellen Anleitung unter https://www.phusionpassenger.com/documentation/Users%20guide%20Apache.html#installation folgen.

Vorbereitungen

• checkout / clone des Repositories in ein lokales Verzeichnis. Z.B.:

  sudo mkdir -p /var/rails
  cd /var/rails
  git clone git@github.com:bfpi/klarschiff-backoffice.git

• Intitialisierung und Datenholung der Git-Submodule in dem gerade angelegtem Verzeichnis

  git submodule init
  git submodule update

• Installation der notwendigen Rubyversion und des Gemsets

  • Bei Wechsel in das Repository-Verzeichnis hilft RVM mit der Einrichtung

  • Gegebenenfalls muss das entsprechende Ruby installiert werden:

    rvm install ruby-2.7.1

  • Ein erneuter Wechsel in das Verzeichnis legt anschließend die notwendigen Wrapper und das Gemset an

    ruby-2.7.1 - #gemset created /usr/local/rvm/gems/ruby-2.7.1@klarschiff-backoffice-r01
    ruby-2.7.1 - #generating klarschiff-backoffice-r01 wrappers................

  • Falls bundler nicht (mehr) als Default-Gem durch RVM installiert wird, kann dies wie folgt nachgeholt werden:

    gem install bundler --no-ri --no-rdoc

  • Zur Installation der Gems für die Anwendung ist im Verzeichnis nun folgender Aufruf notwendig:

    bundle install

  • Zusätzliche Javascript-Bibliotheken werden wie folgt installiert:

    rake assets:libs

Konfiguration der Applikation

Für die Konfigurationsdateien mit vertraulichem Inhalt gibt es versionierbare Vorlagen mit dem Namen xyz.sample.yml. Diese müssen in das Verzeichnis overlay/config/ kopiert und entsprechend ohne das sample als xyz.yml benannt werden. Die für die Umgebung gültigen Werte werden dann in der xyz.yml konfiguriert.

• settings.yml
• database.yml

Konfigurationen in der config/secrets.yml

Diese Datei dient der Konfiguration zur Verschlüsselung der internen Nutzerdaten (Cookies, usw.).

• Die Konfiguration erfolgt hier nach Rails-Konvention pro Umgebung. Es muss aber nur die Variante mit der entsprechenden Umgebung konfiguriert werden. Also production in der Produktivumgebung und der Demo-Umgebung. Die RAILS_ENV test ist für automatisierte Tests im Framework vorbehalten.

Precompilieren der Assets (Bilder, JS, Stylesheets)

rake assets:precompile