From 82a1e1179721b810e7d35f9647aef44f52d6b0e5 Mon Sep 17 00:00:00 2001 From: ISA Date: Tue, 24 Jun 2025 07:17:36 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20=20=C3=BCberarbeitete=20/docs/README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.development | 2 +- .env.production | 2 +- docs/README.md | 94 +++++++++++++++++++++++------------------------ package-lock.json | 4 +- package.json | 2 +- 5 files changed, 51 insertions(+), 53 deletions(-) diff --git a/.env.development b/.env.development index 150824dbe..be7000ea2 100644 --- a/.env.development +++ b/.env.development @@ -25,4 +25,4 @@ NEXT_PUBLIC_USE_MOCKS=true NEXT_PUBLIC_BASE_PATH=/talas5 # Oder leer lassen für direkten Zugriff -> NEXT_PUBLIC_BASE_PATH= # App-Versionsnummer -NEXT_PUBLIC_APP_VERSION=1.1.283 +NEXT_PUBLIC_APP_VERSION=1.1.284 diff --git a/.env.production b/.env.production index 013e044a8..e8633d676 100644 --- a/.env.production +++ b/.env.production @@ -26,4 +26,4 @@ NEXT_PUBLIC_BASE_PATH=/talas5 # Oder leer lassen für direkten Zugriff -> NEXT_PUBLIC_BASE_PATH= # App-Versionsnummer -NEXT_PUBLIC_APP_VERSION=1.1.283 \ No newline at end of file +NEXT_PUBLIC_APP_VERSION=1.1.284 \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index dc2e1eb19..c83d780c4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 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. --- @@ -13,7 +13,7 @@ Entwicklung, Architekturverständnis und Erweiterung. ### 🔹 Einstieg & Übersicht -- [Projektüberblick](architecture.md) +- [Projektüberblick](#projektüberblick) - [Build & Deployment](build-and-deploy.md) - [Checkliste für Deployment](checklist.md) - [Dynamische Marker erklärt](DynamischeMarkerErklaerung.md) @@ -60,18 +60,16 @@ Entwicklung, Architekturverständnis und Erweiterung. - [EditModeToggle](components/uiWidgets/mapLayersControlPanel/EditModeToggle.md) - [MapLayersControlPanel](components/uiWidgets/mapLayersControlPanel/MapLayersControlPanel.md) -### 🔍 Weitere Tools +### 🧪 Weitere Tools - [TestScript (Debug)](components/TestScript.md) --- ---- +## Projektüberblick -## 🔍 Projektüberblick - -NodeMap wird von **TALAS.web** über einen iFrame geladen. Die Anwendung verwendet moderne -Technologien wie: +NodeMap wird von **TALAS.web** über einen iFrame geladen. Die Anwendung basiert auf folgenden +Technologien: | Technologie | Zweck | | ------------- | ------------------------------ | @@ -82,86 +80,86 @@ Technologien wie: | MySQL | Datenbank | | 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 - Windows-Server mit IIS -- Datenzugriff über Webservice oder lokale API +- Datenzugriff über TALAS-Webservice oder lokale API -🚀 **Lokale Entwicklung starten:** -➡ [Entwicklungssetup](guide/setup-dev.md) +### Lokale Entwicklung -📁 **Verzeichnisstruktur verstehen:** -➡ [Projektstruktur erklärt](guide/project-structure.md) - -🛠️ **Abhängigkeiten & Tools:** -➡ [dependencies.md](guide/dependencies.md) - -🌐 **Umgebungsvariablen (env-Dateien):** -➡ [env.md](guide/env.md) +➡ [Entwicklungs-Setup](guide/setup-dev.md) +➡ [Projektstruktur erklärt](guide/project-structure.md) +➡ [Abhängigkeiten & Tools](guide/dependencies.md) +➡ [Umgebungsvariablen (env-Dateien)](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. -2. **Lokale Next.js API** (Port 3000) – eigene Datenbankabfragen via MySQL +1. **TALAS-WebServices** (Port 80) – POIs, Geräte, Rechte, Linien usw. +2. **Lokale Next.js API** (Port 3000) – direkte Datenbankzugriffe via MySQL ➡ [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 -organisiert: +Die komplette Anwendung verwendet Redux zur globalen Zustandverwaltung. -- Datenfluss: `Service` → `Thunk` → `Slice` → `Komponente` -- Beispiel: POI-Daten, Gerätemarker, Rechteprüfung, Sichtbarkeiten +- Architektur: `Service → Thunk → Slice → Komponente` +- Beispiel: POIs, Marker, Linien, Rechte, Layer-Status +- Redux DevTools werden unterstützt ➡ [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` -- ✔ API-Antworten werden lokal simuliert -- ✔ Redux prüft, ob `process.env.NEXT_PUBLIC_USE_MOCKS === true` +- Aktivierung über `.env.local → NEXT_PUBLIC_USE_MOCKS=true` +- Nutzung z. B. in `pages/api/mocks/...` +- Hinweise im UI zeigen aktivierten Mockmodus ➡ [Mockdaten & Entwicklung](guide/mock-data.md) --- -## ❗ Fehlerbehandlung & Glossar +## Fehlerbehandlung & Glossar -Typische Probleme bei Installation, Deployment oder Datenzugriff: - -➡ [FAQ & häufige Fehler](guide/faq.md) - -Begriffe wie `POI`, `IdMap`, `Station`, `Layer`, `Slice` erklärt: +Typische Probleme (z. B. Webservice nicht erreichbar, Layer nicht sichtbar) werden in der FAQ +gesammelt. +Zudem gibt es eine Begriffsliste zur Orientierung: +➡ [FAQ & häufige Fehler](guide/faq.md) ➡ [Glossar](guide/glossar.md) --- -## 🔄 Hinweis zum Deployment +## Hinweis zum Deployment -Für die Anleitung zur Installation auf dem Server → siehe -📦 [Root-README.md im Projektverzeichnis](../README.md) +📦 Die Anleitung für Server-Installation und ZIP-Deployment findest du in: +➡ [Root-README.md](../README.md) --- -🧩 **Fragen oder neue Entwickler im Team?** -Diese README ist der beste Startpunkt und enthält alle Links zur vertieften technischen -Dokumentation. +## Tipp + +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“. diff --git a/package-lock.json b/package-lock.json index 18bddf5cd..2e1b19e63 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "nodemap", - "version": "1.1.283", + "version": "1.1.284", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "nodemap", - "version": "1.1.283", + "version": "1.1.284", "dependencies": { "@emotion/react": "^11.13.3", "@emotion/styled": "^11.13.0", diff --git a/package.json b/package.json index 1ac413ceb..58665b51f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nodemap", - "version": "1.1.283", + "version": "1.1.284", "dependencies": { "@emotion/react": "^11.13.3", "@emotion/styled": "^11.13.0",