docs: Screenshots in README.md

This commit is contained in:
ISA
2025-06-05 11:28:56 +02:00
parent 40cb07b485
commit 9273195d8f
16 changed files with 302 additions and 49 deletions

65
docs/guide/faq.md Normal file
View File

@@ -0,0 +1,65 @@
<!-- /docs/guide/faq.md -->
# ❓ FAQ Häufige Fragen
---
### 🔹 Warum sehe ich nur eine weiße Seite?
- Stelle sicher, dass `.env.production` korrekt konfiguriert ist.
- Prüfe, ob `NEXT_PUBLIC_USE_MOCKS=false` gesetzt ist (nur in Produktion).
- Starte den Dienst neu (**NodeMapService**) oder führe `npm start` im Terminal aus.
---
### 🔹 Was bedeutet die URL `?m=12&u=484`?
- `m=12` ist die **Map-ID** (z.B. Leverkusen).
- `u=484` ist die **User-ID**.
- Diese IDs werden vom übergeordneten System (**TALAS.web**) übergeben und steuern, was angezeigt
wird.
---
### 🔹 Wie kann ich POIs hinzufügen oder bearbeiten?
- Rechtsklick auf die Karte → **„POI hinzufügen“** oder **„bearbeiten“**.
- Daten werden automatisch gespeichert, wenn du das Formular bestätigst.
---
### 🔹 Wie kann ich die Karte lokal testen, ohne Backend?
- Setze in `.env.local` die Variable `NEXT_PUBLIC_USE_MOCKS=true`.
- Starte mit `npm run dev`.
- Die App lädt jetzt Mockdaten aus `/mockData/`.
---
### 🔹 Was mache ich, wenn keine Marker angezeigt werden?
- Prüfe die Verbindung zum Webservice:
`http://<ip>/talas5/ClientData/WebServiceMap.asmx`
- Stelle sicher, dass die **Map-ID** und **User-ID** in der URL gültig sind.
---
### 🔹 Wie erkenne ich, ob mein Layer (z.B. TALAS, WAGO, GMA) geladen ist?
- Im rechten Panel (**LayerControl**) sollten Checkboxen für jeden Layer erscheinen.
- Wenn keine Layer sichtbar sind, prüfe `redux/mapLayersSlice` und den Webservice `GisSystemStatic`.
---
### 🔹 Was tun bei der Meldung „Fehler beim Laden der Kartenkacheln“?
- Verzeichnis `C:\inetpub\wwwroot\talas5\TileMap` prüfen.
- Kartenkacheln müssen im `public/`-Pfad korrekt verlinkt sein (z.B. `mapTiles/...`).
---
### 🔹 Wie kann ich die Anwendung aktualisieren?
- **Kleines Update:** Nur `.next/` kopieren.
- **Größeres Update:** Gesamte App inkl. `node_modules`, `.env.production` und `public/` ersetzen.
- Dienst neu starten.

28
docs/guide/glossar.md Normal file
View File

@@ -0,0 +1,28 @@
# 📘 Glossar
Eine Übersicht wichtiger Begriffe rund um NodeMap und die verwendeten Technologien.
| Begriff | Erklärung |
| -------------------- | ----------------------------------------------------------------------------------------- |
| **NodeMap** | Die Kartenanwendung zur Darstellung von GIS-Daten (z.B. POIs, Geräte) in TALAS.web. |
| **Next.js** | Ein Webframework für React, das Server-Rendering und Routing vereinfacht. |
| **React** | Eine JavaScript-Bibliothek zur Erstellung von Benutzeroberflächen (UI). |
| **Redux Toolkit** | Ein Tool zur einfacheren Zustandverwaltung (State Management) für React. |
| **Tailwind CSS** | Ein CSS-Framework mit vordefinierten Klassen für schnelles UI-Design. |
| **Leaflet** | Eine JavaScript-Bibliothek für interaktive Karten auf Webseiten. |
| **POI** | „Point of Interest“ Ein Marker auf der Karte (z.B. ein Gerät, Schacht oder Messpunkt). |
| **MapComponent** | Die Hauptkomponente, die die Karte lädt und alle Inhalte darauf anzeigt. |
| **WebService** | Ein Serverdienst, der Daten wie POIs, Linien, Geräte liefert (z.B. aus TALAS). |
| **.env.production** | Eine Konfigurationsdatei mit Zugangsdaten und Einstellungen für den Live-Betrieb. |
| **Mockdaten** | Testdaten, die lokal geladen werden, wenn kein Server verfügbar ist (`USE_MOCKS=true`). |
| **iFrame** | Ein HTML-Element, mit dem eine andere Webseite innerhalb einer Seite eingebettet wird. |
| **nssm.exe** | Ein Tool, um Node.js-Anwendungen als Windows-Dienst laufen zu lassen. |
| **Port 3000** | Der lokale Entwicklungs-Port, unter dem NodeMap im Browser erreichbar ist. |
| **Redux Slice** | Ein Teil des globalen Redux-Zustands, der z.B. POIs oder Linien speichert. |
| **Thunk** | Eine asynchrone Funktion in Redux, z.B. um Daten vom Server zu laden. |
| **Contextmenü** | Ein Rechtsklick-Menü mit Funktionen wie „POI hinzufügen“, „Station öffnen“. |
| **Layer** | Ein Karten-Overlay (z.B. Geräte, Linien), das ein- oder ausgeblendet werden kann. |
| **IdSystem / IdMap** | Interne IDs zur Zuordnung von Layern und Karten in TALAS. |
| **GisSystemStatic** | Eine Webservice-Antwort mit Systeminformationen für die Kartendarstellung. |
| **mapTiles** | Bildkacheln (z.B. `.png`), die die Grundkarte darstellen wie bei Google Maps. |
| **TALAS.web** | Die bestehende (ältere) Verwaltungssoftware, in die NodeMap eingebettet wird. |

View File

@@ -0,0 +1,76 @@
## ✅ Onboarding-Checkliste für neue Entwickler bei NodeMap
Willkommen im NodeMap-Team! Diese Checkliste begleitet dich Schritt für Schritt beim Einstieg ins
Projekt.
---
### 🚦 Schritte zum Start
1. **README.md lesen**
_Verschaffe dir einen Überblick über das Projekt._
☐ Erledigt
2. **Repository clonen & installieren**
```bash
git clone http://10.10.0.12:3000/ISA/nodeMap
cd nodeMap
npm install
```
☐ Erledigt
3. **`.env.local` anlegen**
_Siehe [env.md](docs/guide/env.md) für Details._
☐ Erledigt
4. **Mock-Modus aktivieren**
```env
NEXT_PUBLIC_USE_MOCKS=true
```
☐ Erledigt
5. **Projekt starten**
```bash
npm run dev
```
☐ Erledigt
6. **App im Browser öffnen**
_Gehe zu:_ [http://localhost:3000](http://localhost:3000)
☐ Erledigt
7. **POIs testen**
_Hinzufügen, Verschieben, Löschen siehe [user-guide.md](docs/guide/user-guide.md)._
☐ Erledigt
8. **Redux DevTools installieren & testen**
_Empfohlen für Debugging._
☐ Erledigt
9. **Projektstruktur ansehen**
_Wichtige Ordner: `components/`, `redux/`, `services/` siehe
[project-structure.md](docs/guide/project-structure.md)._
☐ Erledigt
10. **Webservices überfliegen**
_Siehe [webservices.md](docs/guide/webservices.md)._
☐ Erledigt
11. **Fehlerbehandlung beachten**
_Hinweise dazu findest du im README._
☐ Erledigt
12. **Fragen notieren & klären**
_Sammle offene Punkte und sprich sie im Team an._
☐ Erledigt
---
**Tipp:** Hake jeden Schritt ab, sobald du ihn erledigt hast.
Viel Erfolg beim Einstieg! 🎉

54
docs/guide/setup-dev.md Normal file
View File

@@ -0,0 +1,54 @@
# 🧑‍💻 Lokale Entwicklung mit NodeMap
Diese Anleitung richtet sich an Entwickler, die NodeMap lokal weiterentwickeln möchten.
---
## Voraussetzungen
- Node.js v18+
- NPM
- Chrome / Edge / Firefox
---
## Schritte
```bash
npm install
npm run dev
```
---
## Optionen
- **Mockdaten-Modus aktivieren:**
```env
NEXT_PUBLIC_USE_MOCKS=true
```
- **Umgebungsvariablen lokal definieren:**
Datei `.env.local` mit Inhalten wie:
```
NEXT_PUBLIC_API_URL=http://localhost:3001
NEXT_PUBLIC_USE_MOCKS=true
```
---
## Debugging
- Verwende `console.log` in Komponenten oder Redux-Slices
- Browser-DevTools & Redux DevTools empfohlen
---
## Weitere Dokumentation
- Projektstruktur: [project-structure.md](project-structure.md)
- Webservices: [webservices.md](webservices.md)
- Zustandverwaltung: [redux-zustand.md](redux-zustand.md)

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 191 KiB