Files
nodeMap/docs/README.md
2025-06-24 07:07:43 +02:00

4.7 KiB
Raw Blame History

📘 NodeMap Entwicklerdokumentation

Willkommen in der Entwicklerdokumentation für NodeMap einer modularen Kartenanwendung zur Visualisierung und Bearbeitung von GIS-Daten, POIs und Gerätestatus in einer interaktiven Leaflet-Karte.

Diese Anleitung führt dich Schritt für Schritt durch die wichtigsten Bereiche für lokale Entwicklung, Architekturverständnis und Erweiterung.


📚 Inhaltsverzeichnis

🔹 Einstieg & Übersicht

🧭 Architektur

⚙️ Konfiguration

🧩 Hauptkomponenten

🗺️ Kontextmenü

POIs

📏 GIS-Polylinien

💡 UI-Komponenten

🔍 Weitere Tools



🔍 Projektüberblick

NodeMap wird von TALAS.web über einen iFrame geladen. Die Anwendung verwendet moderne Technologien wie:

Technologie Zweck
Next.js React-Framework (Frontend/SSR)
Leaflet Kartendarstellung
Redux Toolkit Zustandverwaltung
Tailwind CSS Styling
MySQL Datenbank
Node.js / IIS Server und Auslieferung

➡ Mehr zur Architektur: architecture.md


🧱 Projektstruktur & Setup

🔧 Zielsystem:

  • Offline-Umgebung
  • Windows-Server mit IIS
  • Datenzugriff über Webservice oder lokale API

🚀 Lokale Entwicklung starten:
Entwicklungssetup

📁 Verzeichnisstruktur verstehen:
Projektstruktur erklärt

🛠️ Abhängigkeiten & Tools:
dependencies.md

🌐 Umgebungsvariablen (env-Dateien):
env.md


🔌 Webservices & API-Fluss

NodeMap greift auf zwei Datenquellen zu:

  1. TALAS-WebServices (Port 80) Gerätedaten, POIs, Rechte etc.
  2. Lokale Next.js API (Port 3000) eigene Datenbankabfragen via MySQL

Webservices-Dokumentation


🧠 Zustandverwaltung (Redux)

Alle Karten- und Gerätefunktionen (z.B. Marker, Linien, POIs) sind über Redux-Slices und Thunks organisiert:

  • Datenfluss: ServiceThunkSliceKomponente
  • Beispiel: POI-Daten, Gerätemarker, Rechteprüfung, Sichtbarkeiten

Zustandverwaltung mit Redux


🧪 Entwicklung & Testdaten

Um auch ohne echte Datenquelle arbeiten zu können:

  • ✔ Mockdaten-Modus über .env.local
  • ✔ API-Antworten werden lokal simuliert
  • ✔ Redux prüft, ob process.env.NEXT_PUBLIC_USE_MOCKS === true

Mockdaten & Entwicklung


Fehlerbehandlung & Glossar

Typische Probleme bei Installation, Deployment oder Datenzugriff:

FAQ & häufige Fehler

Begriffe wie POI, IdMap, Station, Layer, Slice erklärt:

Glossar


🔄 Hinweis zum Deployment

Für die Anleitung zur Installation auf dem Server → siehe
📦 Root-README.md im Projektverzeichnis


🧩 Fragen oder neue Entwickler im Team?
Diese README ist der beste Startpunkt und enthält alle Links zur vertieften technischen Dokumentation.