docs from temp branch

This commit is contained in:
ISA
2025-05-28 10:17:25 +02:00
parent 6248c90838
commit d66727e531
288 changed files with 203 additions and 5158 deletions

View File

@@ -1,48 +0,0 @@
<!-- /docs/services/README.md -->
# ⚙️ `services/` Backend-Services & API-Logik
Dieses Verzeichnis enthält alle Funktionen zur Anbindung von Backend-Systemen, API-Endpunkten und Datenquellen (z.B. Datenbank, POIs, Geräte, Polylinien).
Die Dateien sind nach Anwendungsbereich gegliedert.
---
## 📂 Strukturübersicht
```bash
services/
├── poi/ # Services für Points of Interest
├── devices/ # Geräte- und Standort-Services
├── gis/ # Linien- und Stationsdaten aus GIS
├── system/ # Rechte, Konfiguration, Benutzerzugriff
├── helpers/ # Hilfsfunktionen wie fetchWithTimeout
```
---
## 🧭 Kategorien & Beispiele
| Bereich | Beispiel-Service | Beschreibung |
|-------------|--------------------------------------|-------------------------------------|
| `poi/` | `fetchPoiMarkersService.js` | Holt Marker für POIs |
| `devices/` | `fetchLocationDevicesService.js` | Ruft alle Standort-Geräte ab |
| `gis/` | `fetchGisLinesService.js` | Holt Polylinien aus der Datenbank |
| `system/` | `fetchUserRightsService.js` | Lädt Benutzerrechte |
| `helpers/` | `fetchWithTimeout.js` | Fetch mit automatischem Timeout |
---
## 🔗 Dokumentation
Für jeden Service existiert eine `.md`-Datei mit Beschreibung, Parametern und Beispielen.
Beispiel: [`poi/fetchPoiMarkersService.md`](./poi/fetchPoiMarkersService.md)
---
## 👨‍💻 Zielgruppe
Frontend- und Backend-Entwickler, die:
- API-Aufrufe integrieren
- Daten aus der DB anzeigen oder manipulieren
- Redux oder Thunks mit Services koppeln

View File

@@ -1,16 +0,0 @@
# 📁 `database` Übersicht
## 📄 Enthaltene Dateien
| Datei | Beschreibung |
|-------|--------------|
| [`fetchDeviceNameByIdService.md`](./fetchDeviceNameByIdService.md) | *(Beschreibung ergänzen)* |
| [`fetchLocationDevicesService.md`](./fetchLocationDevicesService.md) | *(Beschreibung ergänzen)* |
| [`fetchPriorityConfigService.md`](./fetchPriorityConfigService.md) | *(Beschreibung ergänzen)* |
| [`getDeviceIdByNameService.md`](./getDeviceIdByNameService.md) | *(Beschreibung ergänzen)* |
| [`updateLocationInDatabaseService.md`](./updateLocationInDatabaseService.md) | *(Beschreibung ergänzen)* |
---
🔼 [Zurück zu `components`](../README.md)

View File

@@ -1,12 +0,0 @@
# 📁 `area` Übersicht
## 📄 Enthaltene Dateien
| Datei | Beschreibung |
|-------|--------------|
| [`updateAreaService.md`](./updateAreaService.md) | *(Beschreibung ergänzen)* |
---
🔼 [Zurück zu `components`](../README.md)

View File

@@ -1,12 +0,0 @@
# 📁 `locationDevice` Übersicht
## 📄 Enthaltene Dateien
| Datei | Beschreibung |
|-------|--------------|
| [`fetchLocationDevicesService.md`](./fetchLocationDevicesService.md) | *(Beschreibung ergänzen)* |
---
🔼 [Zurück zu `components`](../README.md)

View File

@@ -1,19 +0,0 @@
# 📁 `pois` Übersicht
## 📄 Enthaltene Dateien
| Datei | Beschreibung |
|-------|--------------|
| [`addPoiService.md`](./addPoiService.md) | *(Beschreibung ergänzen)* |
| [`deletePoiService.md`](./deletePoiService.md) | *(Beschreibung ergänzen)* |
| [`fetchPoiDataByIdService.md`](./fetchPoiDataByIdService.md) | *(Beschreibung ergänzen)* |
| [`fetchPoiDataService.md`](./fetchPoiDataService.md) | *(Beschreibung ergänzen)* |
| [`fetchPoiIconsDataService.md`](./fetchPoiIconsDataService.md) | *(Beschreibung ergänzen)* |
| [`fetchPoiMarkersService.md`](./fetchPoiMarkersService.md) | *(Beschreibung ergänzen)* |
| [`fetchPoiTypService.md`](./fetchPoiTypService.md) | *(Beschreibung ergänzen)* |
| [`updatePoiService.md`](./updatePoiService.md) | *(Beschreibung ergänzen)* |
---
🔼 [Zurück zu `components`](../README.md)

View File

@@ -1,13 +0,0 @@
# 📁 `polylines` Übersicht
## 📄 Enthaltene Dateien
| Datei | Beschreibung |
|-------|--------------|
| [`fetchGisLinesService.md`](./fetchGisLinesService.md) | *(Beschreibung ergänzen)* |
| [`updatePolylineCoordinatesService.md`](./updatePolylineCoordinatesService.md) | *(Beschreibung ergänzen)* |
---
🔼 [Zurück zu `components`](../README.md)

View File

@@ -1,12 +0,0 @@
# 📁 `utils` Übersicht
## 📄 Enthaltene Dateien
| Datei | Beschreibung |
|-------|--------------|
| [`fetchWithTimeout.md`](./fetchWithTimeout.md) | *(Beschreibung ergänzen)* |
---
🔼 [Zurück zu `components`](../README.md)

View File

@@ -1,17 +0,0 @@
# 📁 `webservice` Übersicht
## 📄 Enthaltene Dateien
| Datei | Beschreibung |
|-------|--------------|
| [`fetchGisLinesStatusService.md`](./fetchGisLinesStatusService.md) | *(Beschreibung ergänzen)* |
| [`fetchGisStationsMeasurementsService.md`](./fetchGisStationsMeasurementsService.md) | *(Beschreibung ergänzen)* |
| [`fetchGisStationsStaticDistrictService.md`](./fetchGisStationsStaticDistrictService.md) | *(Beschreibung ergänzen)* |
| [`fetchGisStationsStatusDistrictService.md`](./fetchGisStationsStatusDistrictService.md) | *(Beschreibung ergänzen)* |
| [`fetchGisSystemStaticService.md`](./fetchGisSystemStaticService.md) | *(Beschreibung ergänzen)* |
| [`fetchUserRightsService.md`](./fetchUserRightsService.md) | *(Beschreibung ergänzen)* |
---
🔼 [Zurück zu `components`](../README.md)

View File

@@ -57,4 +57,4 @@ Lädt Linienstatus-Daten über den TALAS WebService.
| `fetchGisLinesStatusService.js` | WebService-Aufruf |
| `fetchGisLinesStatusThunk.js` | Redux Thunk |
| `gisLinesStatusSlice.js` | Redux Slice |
| `store.js` | Integration des Slices |
| `store.js` | Integration des Slices |