GardenPlanner/README.md

49 lines
2.6 KiB
Markdown
Raw Normal View History

2023-06-25 10:13:39 +02:00
# Beet Pflanz-App
2023-06-25 14:47:16 +02:00
[![pipeline status](https://gitlab.vierling.cloud/Joerg/garden-planner/badges/main/pipeline.svg)](https://gitlab.vierling.cloud/Joerg/cpd_project/-/commits/main)
2023-06-25 10:13:39 +02:00
2023-06-25 15:41:26 +02:00
[![Coverage](https://sonar.vierling.cloud/api/project_badges/measure?project=gardenplannerv1&metric=coverage&token=sqb_66e763bc8999d045486b645fbaa139aa687a0d7a)](https://sonar.vierling.cloud/dashboard?id=gardenplannerv1)
[![Code Smells](https://sonar.vierling.cloud/api/project_badges/measure?project=gardenplannerv1&metric=code_smells&token=sqb_66e763bc8999d045486b645fbaa139aa687a0d7a)](https://sonar.vierling.cloud/dashboard?id=gardenplannerv1)
[![Quality Gate Status](https://sonar.vierling.cloud/api/project_badges/measure?project=gardenplannerv1&metric=alert_status&token=sqb_66e763bc8999d045486b645fbaa139aa687a0d7a)](https://sonar.vierling.cloud/dashboard?id=gardenplannerv1)
2023-06-25 10:13:39 +02:00
2023-06-25 15:03:48 +02:00
- CI Pipeline durch Gitlab https://gitlab.vierling.cloud/Joerg/garden-planner
- Qualitätssicherung durch SonarQube https://sonar.vierling.cloud
2023-06-25 10:13:39 +02:00
Die Beet Pflanz-App ist eine Flutter-Anwendung, die im Rahmen des Studiums an der HS-Mannheim für CPD entwickelt wurde.
2023-06-25 20:48:07 +02:00
Die App unterstützt den Benutzer sein Beet zu planen und die optimalen Setzpositionen zu bestimmen.
2023-06-25 10:13:39 +02:00
Zudem können die wichtigen Informationen der Pflanzen über das Jahr angezeigt werden.
2023-06-25 20:49:14 +02:00
Das Beet kann gespeichert werden und wird beim Starten geladen.
2023-06-25 10:13:39 +02:00
2023-06-25 21:41:49 +02:00
## Unterstützte Platformen
- Windows
- Linux
- Android
### Funktionen
2023-06-25 14:23:10 +02:00
- Optimiert für Tablets und Desktop
- Android Mobiltelefon Unterstützung ab 1.080 x 2.400 Pixel
2023-06-25 20:48:07 +02:00
- Darstellung der Beetreihen und Pflanzenplatzierungen
2023-06-25 10:13:39 +02:00
- Drag-and-Drop zum Hinzufügen von Pflanzen
2023-06-25 20:48:07 +02:00
- Entfernung von gepflanzten Pflanzen
2023-06-25 10:13:39 +02:00
- Option zur Anzeige von Platzanforderungen für jede Reihe
- Anzeige von wichtigen Informationen der Pflanzen über das ganze Jahr
- Speichern des aktuellen Beets
- Laden des gespeicherten Beets
2023-06-25 21:41:49 +02:00
#### Zukünftige Funktionen
2023-06-25 20:48:07 +02:00
- Anzeigen der Wassermengen der einzelnen Pflanzen bzw. Reihen
2023-06-25 10:13:39 +02:00
- Verwalten von mehreren Beeten
2023-06-25 14:23:10 +02:00
- Verbesserte Mobilansicht
2023-06-25 10:13:39 +02:00
2023-06-25 21:41:49 +02:00
##### Installation
2023-06-25 14:23:10 +02:00
1. Flutter muss installiert sein
2. Öffnen Sie die Datei lib/constants.dart und stellen Sie sicher, dass die richtige API-URL eingetragen ist.
1. Online Version [[https://cpd.vierling.cloud]) ](https://cpd.vierling.cloud)
2. Eigen Gehostete Docker-Compose verfügbar unter [[Gitlab]) ](https://gitlab.vierling.cloud/Joerg/garden-planner-api)
1. Wenn Sie die App lokal ausführen möchten, passen Sie die API-URL auf http://localhost:3000 an.
2. Befehl zum starten der API <code>docker-compose up --build</code> in der Kommandozeile