Developer Guidelines

1. Aufsetzen der Projektumgebung
2. Definition of Done
3. Verwendete Werkzeuge und Bibliotheken
4. Code Konventionen
5. Struktur des Repos
6. NPM Scripts
7. Github Workflows

Allgemeines

Definition of Done

1. Die angegebenen Anforderungen an die Funktionalität sind erreicht.
2. Der Code ist ausreichend dokumentiert.
3. Clean Code Kriterien sind eingehalten.
4. Falls eine kritische Funktion für die Anwendung implementiert wird, muss diese ebenfalls ausreichend durch Unit Tests abgedeckt sein.

Verwendete Werkzeuge und Bibliotheken

Die wichtigsten verwendeten Werkzeuge sind:

• Volar
• Husky ist zuständig für das Ausführen der Pre-Commit Hooks und ist daher unerlässlich für die lokale Entwicklung. Es wird automatisch initialisiert, wenn die Projektumgebung aufgesetzt wird.
• ESLint wird für das Linten vom Code verwendet.
• Prettier wird für die automatische Formatierung des Codes verwendet.
• commit-lint wird für die automatische Überprüfung der Commit Messages verwendet.

Die wichtigsten verwendeten Bibliotheken sind:

• Vue 3 ist das Framework, welches für die Entwicklung der Anwendung verwendet wird.
• Leaflet ist für die Kartenfunktionalität zuständig und stellt viel Funktionalität für die Interaktion mit Markern bereit.
• Mapbox stellt die Directions und Geocoding API bereit. Die Directions API wird dazu verwendet, indiviuelle Routen (z.B. eines E-Scooters) zur Laufzeit anzufragen und zu cachen. Die Geocoding API wird benutzt, um den Start- und Zielort von Trips von LatLngs in eine Straße umzuwandeln (Reverse Geocoding).