Commit 1eeb5dca authored by Micha Lutz's avatar Micha Lutz

readme draft

parent 60efbfdc
## Run this Application
# Subscriber App
Complete the following steps to run this application:
> This web application by fortiss GmbH is a reference client for the Application Subscriber API of the FIT-Connect PoC. It has been developed as a minimal viable product (MVP) to showcase the main idea of the FIT-Connect PoC from the point of view of a government agency portal.
>
> The Subscriber App is complemented by the Sender App, which demonstrates the FIT-Connect PoC from the point of view of a citizen portal:
> https://git.fortiss.org/fit-connect/sender-app
### 1. Download Repository
Diese Web-Anwendung von fortiss GmbH ist ein Referenz-Client für die Application Subscriber API des FIT-Connect PoC. Sie wurde als Minimal Viable Product (MVP) entwickelt, um die Grundidee des FIT-Connect PoC aus Sicht eines Behördenportals zu demonstrieren.
Download the repository to a local folder
Die Subscriber App wird durch die Sender App ergänzt, welche den FIT-Connect PoC aus Sicht eines BürgerInnen-Portals demonstriert:
https://git.fortiss.org/fit-connect/sender-app
### 2. Install Node JS and NPM
## FIT-Connect PoC
For Windows, follow this documentation: https://docs.microsoft.com/en-us/windows/nodejs/setup-on-windows
FIT-Connect wird als PoC von [FITKO](https://www.fitko.de/) bereitgestellt. Das Ziel von FIT-Connect ist eine einfache, schnelle Integration von Anwendungen zu OZG-Verfahren in medienbruchfreie Antragsprozesse.
### 3. Install Application
Weitere Informationen sind in der FIT-Connect Dokumentation erhältlich: https://docs.fiep-poc.de/docs
Open cmd, switch to the local folder of the application and run `npm install`
## Funktionsweise der Subscriber App
### 4. Start Application in Development Mode
Die Web-Anwendung basiert auf dem Node JS React Framework. Beim Aufrufen der Web-Anwendung wird die Komponente src/App.js geladen, welche initial folgende Schritte durchführt:
Now run `npm start`. A new browser tab will open and display this application.
1. Access Token vom Authentication Provider abrufen (Zugangsdaten in src/config.js)
2. Eine Destination (Zustellpunkt einer Behörde) von Subscriber API abrufen. Falls keine existiert, eine neue Destination anlegen
3. Offene Anträge von Subscriber API abrufen
Die Grunddaten der offenen Anträge werden anschließend in der Web-Anwendung angezeigt. Es existiert ein Button, um die Anzeige zu aktualisieren.
Für jedenen offenen Antrag sind folgende Aktionen in der Web-Anwendung möglich:
1. Antrags-Daten von Subscriber API herunterladen
2. Antrags-Dokumente von Subscriber API herunterladen
3. Antrag abschließen
## Installation
Befolgen Sie die folgenden Schritte, um die Web-Anwendung lokal zu installieren
### 1. Node JS und NPM installieren
Falls Node JS und NPM noch nicht auf Ihrem Rechner installiert sind, laden Sie die für Ihr System passende Installationsdatei hier herunter und führen diese aus: https://nodejs.org/en/download/
Im Anschluss sollten folgende Befehle in der Eingabeaufforderung die entsprechenden Versionsnummern fehlerfrei anzeigen:
```
node --version
npm --version
```
Diese Web-Anwendung wurde unter der Node JS Version 12.16.1 entwickelt.
### 2. Quellcode herunterladen
Laden Sie den Quellcode aus diesem Git Repository in ein neues Verzeichnis auf Ihren Rechner. Sie können hierzu in Gitlab den Download-Button nutzen, um den Quellcode als ZIP-Datei herunterzuladen und diese anschließend zu entpacken.
### 3. Anwendung installieren
Öffnen Sie die Eingabeaufforderung und wechseln sie in das Verzeichnis, in dem sich nun der Quellcode der Web-Anwendung befindet. Führen Sie anschließend folgenden Befehl aus. Es werden nun alle für diese Anwendung benötigten Node JS Pakete in das Unterverzeichnis node_modules heruntergeladen.
```
npm install
```
### 4. Anwendung im Entwicklermodus starten
Führen Sie abschließend folgenden Befehl aus. Die Web-Anwendung öffnet sich in einem neuen Browser fenster. Sie können die Anwendung beenden, indem sie in der Eingabeaufforderung Strg+C und J eingeben oder die Eingabeaufforderung schließen.
```
npm start
```
## Kontakt
Diese Anwendung wurde von Micha Lutz bei fortiss GmbH entwickelt. Kontakt: Peter Kuhn, pkuhn@fortiss.org
## Lizenz
??
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment