docs: Screenshots in README.md

2025-06-05 11:28:56 +02:00
parent 40cb07b485
commit 9273195d8f
16 changed files with 302 additions and 49 deletions
--- a/README.md
+++ b/README.md
@@ -5,6 +5,10 @@ Gerätestatus in einer interaktiven Leaflet-Karte.
 Die Anwendung ist mit **Next.js**, **React**, **Redux Toolkit**, **Tailwind CSS** und **Leaflet**
 umgesetzt.

+## 🌍 Live-Vorschau der Karte
+
+![Startansicht der NodeMap Karte](docs/screenshots/overview.png)
+
 ---

 > 🖥 Entwicklung & Test unter Windows 11 mit Node.js v18.17.1 und IIS  
@@ -13,17 +17,6 @@ umgesetzt.

 ---

-## 🧰 Erste Schritte für Entwickler
-
-```bash
-git clone http://10.10.0.12:3000/ISA/nodeMap
-cd nodeMap
-npm install
-npm run dev
-```
-
---
-
 ## 🧭 Zielumgebung

 - Windows-Produktionsserver (offline, kein Internet)
@@ -44,7 +37,7 @@ npm run dev

 ---

-## 🧰 Erstinstallation auf Server (z. B. Windows IIS)
+## 🧰 Erstinstallation auf Server

 ### Voraussetzungen

@@ -63,10 +56,13 @@ npm run dev

 ## 🔗 Integration in TALAS.web

+![iFrame-Integration](docs/screenshots/iframe-in-talas.png)
+
 - Die App wird in einem **iFrame** geladen
 - Startet über `?m=X&u=Y` für Map-/User-ID
 - Rechte und Inhalte werden automatisch geladen
  ```
+  z.B.
  `http://10.10.0.13/talas5/MessagesMap/mapTypC.aspx?m=12&u=484`
  ```

@@ -86,13 +82,18 @@ npm run dev

 2. **ZIP-Paket vorbereiten (lokal):**

-   - Verzeichnisse `.next/`, `public/`, `node_modules/`
-   - Dateien `.env.production`, `package.json`
-   - optional: `nssm.exe`, `StartNodeApp.bat`, `Start-Dev.ps1` um Windows Dienst zu erstellen
-     Download:
+   - Verzeichnis `.next/`
+   - Verzeichnisse `public/`, `node_modules/` falls nich vorhanden sind oder etwas hinzugefügt wurd
+     (Bilder oder Bibliothek)
+   - Dateien `.env.production`, `package.json` falls nich vorhanden sind oder etwas hinzugefügt wurd
+     (Umgebungsvariablen oder Bibliothek)
+   - optional: `nssm.exe`, `StartNodeApp.bat`, `Start-Dev.ps1` um Windows Dienst zu erstellen falls
+     noch nicht vorhanden ist Download:
     [nssm](https://littwinsystemtechnik.sharepoint.com/:f:/r/sites/LittwinSystemtechnik/Freigegebene%20Dokumente/Projekte/Masterkarte%20V2%20setup%20files?csf=1&web=1&e=Sm1wwt)

-3. **Auf Server kopieren nach:**
+3. **Auf Server kopieren nach:** Ein Ordner temp auf dem Desktop erstellen->ZIP-Paket
+   einfügen->entpacken->Inhalt in folgende Verzeichnis einfügen, weil verhindert Windows Server
+   direkt kopieren in folgende Verzeichnis

   ```
   C:\inetpub\wwwroot\talas5\nodeMap\
@@ -100,6 +101,8 @@ npm run dev

 4. **Kartenmaterial hinzufügen (falls nicht vorhanden):**

+   Muss noch in Download-Server eingefügt werden, damit eine zentrale Stelle verfügbar ist
+
   ```
   C:\inetpub\wwwroot\talas5\TileMap\
   ```
@@ -120,7 +123,7 @@ Datenbank-Zugang, Pfade und Mock-Option.
  [nssm](https://littwinsystemtechnik.sharepoint.com/:f:/r/sites/LittwinSystemtechnik/Freigegebene%20Dokumente/Projekte/Masterkarte%20V2%20setup%20files?csf=1&web=1&e=Sm1wwt)

 7. **Starten:**  
-   Dienst starten oder
+   Dienst starten , falls vorhanden einmal beenden und neustarten oder

   ```bash
   npm start in Terminal für Debugging
@@ -179,7 +182,7 @@ wird mit husky Bibliothek automatisch erhöht bei "git commit message"
 >
 > - Port 3000 ist in der Firewall freigegeben
 > - Die IP im Scriptteil von `MapTypC.aspx` ist aktuell (z. B. `10.10.0.13`)
-> - `npm start` läuft oder der Windows-Dienst `NodeMapService` ist aktiv
+> - Windows-Dienst `NodeMapService` ist aktiv oder `npm start` in Terminal ausgeführt

 ## 📁 Dokumentation & technische Leitfäden

@@ -192,15 +195,6 @@ wird mit husky Bibliothek automatisch erhöht bei "git commit message"
 | Mockdaten-Modus           | [mock-data.md](docs/guide/mock-data.md)                 |
 | Zustandverwaltung (Redux) | [redux-zustand.md](docs/guide/redux-zustand.md)         |
 | Abhängigkeiten            | [dependencies.md](docs/guide/dependencies.md)           |
-
---
-
-## 🧰 Fehlerbehandlung
-
- **App startet leer?** → `.env.production` prüfen
- **Kartenkacheln fehlen?** → `public/mapTiles/` korrekt eingebunden?
- **Keine Marker sichtbar?** → Webservice erreichbar?
- Seite neu laden, wenn POIs nicht korrekt geladen werden
- Port 3000 freigeben
-
---
+| Lokale Entwicklung        | [setup-dev.md](docs/guide/setup-dev.md)                 |
+| FAQ & Fehlerbehandlung    | [faq.md](docs/guide/faq.md)                             |
+| Glossar                   | [faq.md](docs/guide/glossar.md)                         |