cpd_2022_zi/README.md

27 lines
1.3 KiB
Markdown

# smoke_cess_app
Eine Flutter App, um Teilnehmer einer Studie des [ZI-Mannheim](https://www.zi-mannheim.de/index.html) zur Rauchentwöhnung bei der Durchführung der Studie zu unterstützen, die entstandenen Daten zu speichern und zugänglich zu machen.
## Dependencies installieren
Vor App-Start:
<code>flutter pub get</code>
## App starten
Die App lässt sich als Android- und iOS App ausführen und zu Debugzwecken ebenfalls als Webapp.
## App bedienen
Um die App nutzen zu können, müssen Settings eingelesen werden. Dazu kann entweder ein in die App integrierter QR-Code Scanner (mit dem beigefügten [QR-Code](./gruppe1_QR.png)) benutzt werden, oder zu Debugzwecken mit dem dafür vorgesehenen Button auf der Scannerseite über eine lokale JSON-Datei.
Es ist zu beachten, dass das verwendete QR-Code Scanner Package für Mobilgeräte optimiert ist. Deshalb kann es zu Abstürzen beim Verwenden des Scanners mit der Web-Version kommen.
Beim Verwenden der Web-Version sollten die Settings mit der lokalen JSON-Datei eingelesen werden.
Der Button zum Einlesen der lokalen JSON-Datei kann über die Variable <code>bool useLocalConfig</code> in der Datei [globals.dart](./lib/globals.dart) ein- und ausgeblendet werden.
## Authoren
- Hinrik Ehrenfried 2012537
- Patrick Meßmer 1911768
- Kai Mannweiler 2012491
- Julian Gegner 1922635