Documentation of the MintApps (in German only)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 

4.5 KiB

Installation

Client Installation

Auf der Release-Seite finden Sie beim entsprechenden Release auch eine ZIP-Datei mit der Bezeichnung „MintApps-0.x.x.zip“. Laden Sie das aktuellste Paket herunter und entpacken Sie es lokal. Die Anwendungen können dann gestartet werden, indem Sie auf die Datei index.html klicken und diese im Browser öffnen. Bitte beachten Sie, dass bei dieser Art der Installation keine Serverkomponente enthalten ist, die für wenige ausgewählte Apps optional benötigt wird.

Um auch die Beispiele für die Quiz Spiele (MINT-Quiz, Pairs, Das große Quiz) zu installieren, können Sie zusätzlich die neueste ZIP-Datei aus dem data-Repository lokal abspeichern und die enthaltenen Beispiele jeweils über die Funktion „Lokales Quiz/Spiel starten“ öffnen.

Installation der Server-Komponente

Voraussetzungen

Voraussetzung zur Nutzung der Server-Komponente sind ein Webserver mit PHP Unterstützung und eine mysql / mariadb Datenbank. Die Installation ist für sogenannte "Managed Webhostings" optimiert, d.h. ein einfacher Dateizugriff (z.B. FTP) ist zur Installation ausreichend.

Methode Raumerstellung

Um zu verhindern, dass Ihr Server mit Anfragen überlastet wird, ist das Einladen von weiteren Mitspieler:innen geschützt. Dabei stehen zwei Optionen zur Verfügung:

  1. Schutz durch ein Captcha
  2. Schutz durch ein Passwort

Legen Sie zunächst fest, welche Methode Sie nutzen möchten. Die Wahl hat Auswirkung auf die Konfiguration der Serverkomponente.

Installationsschritte

  • Laden Sie das aktuelle ZIP-Paket mit den Serverdateien und entpacken Sie dieses lokal.
  • Erstellen Sie das Unterverzeichnis sync auf Ihrem Webserver und kopieren Sie die Dateien aus dem entpackten Verzeichnis server-main/sync in dieses.
  • Kopieren Sie die Datei sync/config.example.php nach sync/config.php und passen Sie die Datenbankparameter an. Geben Sie außerdem eine lange, zufällige Zeichenfolge für die Konstante TOKEN_SECRET an.
  • Wenn Sie ein Passwort (1) für das Erstellen von Räumen vergeben möchten, so tragen Sie dieses in die Konstante ROOM_CREATE_PASS ein. Das Passwort kann entweder als Plain-Text oder auch als md5 Hash angegeben werden. Möchten Sie ein Captcha (2) nutzen, so lassen Sie den Eintrag leer: ROOM_CREATE_PASS = ''.
  • Rufen Sie das Installationsscript https://www.mein-cooler-server.de/sync/install.php mittels des Browsers auf, wobei Sie Ihren Servernamen einsetzen und ggf. Unterverzeichnisse ergänzen. Das Script schließt - wenn alle anderen Einstellungen korrekt sind - mit der Meldung "→ Installation erfolgreich abgeschlossen" ab.
  • Löschen Sie nun die Datei sync/install.php von Ihrem Server!
  • Testen Sie die Funktionalität des Servers durch den Aufruf https://www.mein-cooler-server.de/sync/get-captcha.php. Wenn der Server korrekt funktioniert, zeigt Ihr Browser eine Ausgabe wie
    captcha	"data: image/png;base64,...
    
  • Erstellen Sie auf dem Server nun das Unterverzeichnis app und kopieren Sie alle entpackten Dateien des Clients in dieses.
  • Passen Sie die Konfigurationsdatei app/config.json des Clients so an, dass sie den korrekten Pfad zum Server enthält. Beachten Sie den Schrägstrich am Ende der Url:
{
  "syncUrl": "https://www.mein-cooler-server.de/sync/"
}
  • Des weiteren können Sie in der Konfirgurationsdatei auch Hyperlinks zu je einer Seite mit Impressum (about), Nutzungsbedingungen (terms) und einer Datenschutzerklärung (privacy) ablegen. Diese werden dann in der unteren Leiste der Seit angezeigt.
{
  "syncUrl": "https://my-personal-server.xxx/sync/",
  "aboutUrl": "https://my-personal-server.xxx/about.html",
  "termsUrl": "https://my-personal-server.xxx/terms.html",
  "privacyUrl": "https://my-personal-server.xxx/privacy.html",
}

Nun sollte die App unter https://www.mein-cooler-server.de/app verfügbar sein :-)

Installation der Quiz- und Spiel-Daten

  • Voraussetzung für die Installation, ist dass der Client auf einem Webserver installiert ist.
  • Laden Sie das aktuelle ZIP-Paket mit den Daten und entpacken Sie dieses lokal.
  • Kopieren Sie das Unterverzeichnis data direkt in das Verzeichnis app auf Ihrem Webserver, in dem die anderen Dateien des Clients liegen.

Nun sollten die Spiele bei den entsprechenden Apps (z.B. Pairs) verfügbar sein.