docs: überarbeitete /docs/README.md

This commit is contained in:
ISA
2025-06-24 07:17:36 +02:00
parent 7b68534f7e
commit 82a1e11797
5 changed files with 51 additions and 53 deletions

View File

@@ -25,4 +25,4 @@ NEXT_PUBLIC_USE_MOCKS=true
NEXT_PUBLIC_BASE_PATH=/talas5 NEXT_PUBLIC_BASE_PATH=/talas5
# Oder leer lassen für direkten Zugriff -> NEXT_PUBLIC_BASE_PATH= # Oder leer lassen für direkten Zugriff -> NEXT_PUBLIC_BASE_PATH=
# App-Versionsnummer # App-Versionsnummer
NEXT_PUBLIC_APP_VERSION=1.1.283 NEXT_PUBLIC_APP_VERSION=1.1.284

View File

@@ -26,4 +26,4 @@ NEXT_PUBLIC_BASE_PATH=/talas5
# Oder leer lassen für direkten Zugriff -> NEXT_PUBLIC_BASE_PATH= # Oder leer lassen für direkten Zugriff -> NEXT_PUBLIC_BASE_PATH=
# App-Versionsnummer # App-Versionsnummer
NEXT_PUBLIC_APP_VERSION=1.1.283 NEXT_PUBLIC_APP_VERSION=1.1.284

View File

@@ -4,7 +4,7 @@ Willkommen in der Entwicklerdokumentation für **NodeMap** einer modularen K
Visualisierung und Bearbeitung von GIS-Daten, POIs und Gerätestatus in einer interaktiven Visualisierung und Bearbeitung von GIS-Daten, POIs und Gerätestatus in einer interaktiven
Leaflet-Karte. Leaflet-Karte.
Diese Anleitung führt dich **Schritt für Schritt** durch die wichtigsten Bereiche für lokale Diese Anleitung führt dich **Schritt für Schritt** durch die wichtigsten Themen für lokale
Entwicklung, Architekturverständnis und Erweiterung. Entwicklung, Architekturverständnis und Erweiterung.
--- ---
@@ -13,7 +13,7 @@ Entwicklung, Architekturverständnis und Erweiterung.
### 🔹 Einstieg & Übersicht ### 🔹 Einstieg & Übersicht
- [Projektüberblick](architecture.md) - [Projektüberblick](#projektüberblick)
- [Build & Deployment](build-and-deploy.md) - [Build & Deployment](build-and-deploy.md)
- [Checkliste für Deployment](checklist.md) - [Checkliste für Deployment](checklist.md)
- [Dynamische Marker erklärt](DynamischeMarkerErklaerung.md) - [Dynamische Marker erklärt](DynamischeMarkerErklaerung.md)
@@ -60,18 +60,16 @@ Entwicklung, Architekturverständnis und Erweiterung.
- [EditModeToggle](components/uiWidgets/mapLayersControlPanel/EditModeToggle.md) - [EditModeToggle](components/uiWidgets/mapLayersControlPanel/EditModeToggle.md)
- [MapLayersControlPanel](components/uiWidgets/mapLayersControlPanel/MapLayersControlPanel.md) - [MapLayersControlPanel](components/uiWidgets/mapLayersControlPanel/MapLayersControlPanel.md)
### 🔍 Weitere Tools ### 🧪 Weitere Tools
- [TestScript (Debug)](components/TestScript.md) - [TestScript (Debug)](components/TestScript.md)
--- ---
--- ## Projektüberblick
## 🔍 Projektüberblick NodeMap wird von **TALAS.web** über einen iFrame geladen. Die Anwendung basiert auf folgenden
Technologien:
NodeMap wird von **TALAS.web** über einen iFrame geladen. Die Anwendung verwendet moderne
Technologien wie:
| Technologie | Zweck | | Technologie | Zweck |
| ------------- | ------------------------------ | | ------------- | ------------------------------ |
@@ -82,86 +80,86 @@ Technologien wie:
| MySQL | Datenbank | | MySQL | Datenbank |
| Node.js / IIS | Server und Auslieferung | | Node.js / IIS | Server und Auslieferung |
Mehr zur Architektur: [architecture.md](/docs/architecture.md) 👉 Mehr zur Systemarchitektur: [architecture.md](architecture.md)
--- ---
## 🧱 Projektstruktur & Setup ## Projektstruktur & Setup
🔧 **Zielsystem:** ### Zielsystem
- Offline-Umgebung - Offline-Umgebung
- Windows-Server mit IIS - Windows-Server mit IIS
- Datenzugriff über Webservice oder lokale API - Datenzugriff über TALAS-Webservice oder lokale API
🚀 **Lokale Entwicklung starten:** ### Lokale Entwicklung
➡ [Entwicklungssetup](guide/setup-dev.md)
📁 **Verzeichnisstruktur verstehen:** ➡ [Entwicklungs-Setup](guide/setup-dev.md)
➡ [Projektstruktur erklärt](guide/project-structure.md) ➡ [Projektstruktur erklärt](guide/project-structure.md)
➡ [Abhängigkeiten & Tools](guide/dependencies.md)
🛠️ **Abhängigkeiten & Tools:** ➡ [Umgebungsvariablen (env-Dateien)](guide/env.md)
➡ [dependencies.md](guide/dependencies.md)
🌐 **Umgebungsvariablen (env-Dateien):**
➡ [env.md](guide/env.md)
--- ---
## 🔌 Webservices & API-Fluss ## Webservices & API-Fluss
NodeMap greift auf zwei Datenquellen zu: NodeMap verwendet zwei Quellen für Daten:
1. **TALAS-WebServices** (Port 80) Gerätedaten, POIs, Rechte etc. 1. **TALAS-WebServices** (Port 80) POIs, Geräte, Rechte, Linien usw.
2. **Lokale Next.js API** (Port 3000) eigene Datenbankabfragen via MySQL 2. **Lokale Next.js API** (Port 3000) direkte Datenbankzugriffe via MySQL
➡ [Webservices-Dokumentation](guide/webservices.md) ➡ [Webservices-Dokumentation](guide/webservices.md)
--- ---
## 🧠 Zustandverwaltung (Redux) ## Zustandverwaltung Redux
Alle Karten- und Gerätefunktionen (z.B. Marker, Linien, POIs) sind über Redux-Slices und Thunks Die komplette Anwendung verwendet Redux zur globalen Zustandverwaltung.
organisiert:
- Datenfluss: `Service``Thunk``Slice``Komponente` - Architektur: `Service → Thunk → Slice → Komponente`
- Beispiel: POI-Daten, Gerätemarker, Rechteprüfung, Sichtbarkeiten - Beispiel: POIs, Marker, Linien, Rechte, Layer-Status
- Redux DevTools werden unterstützt
➡ [Zustandverwaltung mit Redux](guide/redux-zustand.md) ➡ [Zustandverwaltung mit Redux](guide/redux-zustand.md)
--- ---
## 🧪 Entwicklung & Testdaten ## Entwicklung & Testdaten
Um auch **ohne echte Datenquelle** arbeiten zu können: Zur Entwicklung ohne echte API stehen lokale Mockdaten zur Verfügung:
- ✔ Mockdaten-Modus über `.env.local` - Aktivierung über `.env.local → NEXT_PUBLIC_USE_MOCKS=true`
- ✔ API-Antworten werden lokal simuliert - Nutzung z.B. in `pages/api/mocks/...`
- ✔ Redux prüft, ob `process.env.NEXT_PUBLIC_USE_MOCKS === true` - Hinweise im UI zeigen aktivierten Mockmodus
➡ [Mockdaten & Entwicklung](guide/mock-data.md) ➡ [Mockdaten & Entwicklung](guide/mock-data.md)
--- ---
## Fehlerbehandlung & Glossar ## Fehlerbehandlung & Glossar
Typische Probleme bei Installation, Deployment oder Datenzugriff: Typische Probleme (z.B. Webservice nicht erreichbar, Layer nicht sichtbar) werden in der FAQ
gesammelt.
➡ [FAQ & häufige Fehler](guide/faq.md) Zudem gibt es eine Begriffsliste zur Orientierung:
Begriffe wie `POI`, `IdMap`, `Station`, `Layer`, `Slice` erklärt:
➡ [FAQ & häufige Fehler](guide/faq.md)
➡ [Glossar](guide/glossar.md) ➡ [Glossar](guide/glossar.md)
--- ---
## 🔄 Hinweis zum Deployment ## Hinweis zum Deployment
Für die Anleitung zur Installation auf dem Server → siehe 📦 Die Anleitung für Server-Installation und ZIP-Deployment findest du in:
📦 [Root-README.md im Projektverzeichnis](../README.md) [Root-README.md](../README.md)
--- ---
🧩 **Fragen oder neue Entwickler im Team?** ## Tipp
Diese README ist der beste Startpunkt und enthält alle Links zur vertieften technischen
Dokumentation. Wenn du neu im Projekt bist, beginne mit dem Kapitel **Projektstruktur & Setup** und folge dann über
die Webservices bis zu den Komponenten.
---
Möchtest du eine `.md`-Datei exportiert zum Einfügen in dein Projektverzeichnis? Ich kann dir sofort
eine Download-Version erstellen. Sag einfach: „Ja, bitte als Datei“.

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{ {
"name": "nodemap", "name": "nodemap",
"version": "1.1.283", "version": "1.1.284",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "nodemap", "name": "nodemap",
"version": "1.1.283", "version": "1.1.284",
"dependencies": { "dependencies": {
"@emotion/react": "^11.13.3", "@emotion/react": "^11.13.3",
"@emotion/styled": "^11.13.0", "@emotion/styled": "^11.13.0",

View File

@@ -1,6 +1,6 @@
{ {
"name": "nodemap", "name": "nodemap",
"version": "1.1.283", "version": "1.1.284",
"dependencies": { "dependencies": {
"@emotion/react": "^11.13.3", "@emotion/react": "^11.13.3",
"@emotion/styled": "^11.13.0", "@emotion/styled": "^11.13.0",