/app-template

Entwickle deine eigene OwnYourData App mit R und Shiny.

Primary LanguageR

App Template

Das App Template stellt alle notwendigen Methoden zum Zugriff auf den Datentresor bereit und bietet das Look & Feel von OwnyourData Apps.

 

Verwendung

Erstelle eine neue OwnYourData App anhand folgender Schritte:

  1. App Struktur einrichten
    führe folgende Befehle auf der Kommandozeile aus:
git clone git@github.com:OwnYourData/app-template.git
mkdir new_app
cp -R app-template/ new_app/
rm -rf app-template/
cd new_app
for i in _app* ; do mv "$i" $(echo $i | cut -c 2-) ; done

Überprüfung: öffne global.R in R-Studio und es sollte möglich sein, die Shiny Applikation zu starten.

  1. Verbindung zum Datentresor aufbauen erstelle das Manifest mit der Datei appManifest.txt
    encodiere das Manifest base64 (zB https://www.base64encode.org/)
    füge das Manifest im eigenen Datentresor hinzu

    Überprüfung: App starten und der Name des Datentresors wird in der App angezeigt

  2. App spezifische Anpassungen durchführen
    bearbeite die Datei appConstants.R und gib App-Titel und Datenstruktur an
    füge im Unterverzeichnis www/ das App-Logo hinzu

    Überprüfung: die gestartete App zeigt die richtigen Informationen an und unter "Gesammelte Daten" können eigene Daten eingegeben werden

  3. Datenquellen implementieren
    bearbeite die Datei appSource.R um Benutzern die Möglichkeit zur Konfiguration der Datenquellen zu geben (Layout)
    in der Datei appLogic.R werden die server-seitigen Funktionalitäten dafür implementiert

    Überprüfung: starte die App, sammle Daten in Datenquellen und überprüfe, ob die Daten im Datentresor abgegelegt werden

  4. Visualisierungen implementieren
    bearbeite die Datei appStatus.R um Benutzern die Möglichkeit zur Visualisierung der vorhandenen Daten zu geben (Layout)
    in der Datei appLogic.R werden die server-seitigen Funktionalitäten dafür implementiert

    Überprüfung: starte die App, zeige die vorhandenen Daten an

  5. Docker Container erstellen bearbeite die Dateien im Unterverzeichnis docker/ und erstelle einen Container mit dem Befehl
    docker build -t APP-NAME .

    Überprüfung: starte den Container und verbinde dich im Browser
    `docker run --name APP_NAME -d -p 3838:3838 APP-NAME

 

Verbessere das App Template

Bitte melde Fehler oder Vorschläge im GitHub Issue-Tracker und halte dich dabei an die Contributor Guidelines.

Wenn du selbst an der App mitentwickeln möchtest, folge diesen Schritten:

  1. Fork it!
  2. erstelle einen Feature Branch: git checkout -b my-new-feature
  3. Commit deine Änderungen: git commit -am 'Add some feature'
  4. Push in den Branch: git push origin my-new-feature
  5. Sende einen Pull Request

 

Lizenz

MIT Lizenz 2017 - OwnYourData.eu