Files
nodeMap/docs/README.md
2025-06-23 14:47:37 +02:00

88 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- /docs/README.md -->
# 🚀 NodeMap Einstieg für Entwickler
Willkommen in der NodeMap-Welt einer Offline-Kartenanwendung zur Verwaltung von POIs und
Gerätestatus für TALAS.web.
---
## 📚 Kapitelübersicht
- [🚀 NodeMap Einstieg für Entwickler](#-nodemap--einstieg-für-entwickler)
- [📚 Kapitelübersicht](#-kapitelübersicht)
- [1. Was ist NodeMap?](#1-was-ist-nodemap)
- [2. Lokale Entwicklung](#2-lokale-entwicklung)
- [3. Systemübersicht](#3-systemübersicht)
- [4. Datenflüsse \& API](#4-datenflüsse--api)
- [5. Tipps](#5-tipps)
- [6. Deployment](#6-deployment)
---
## 1. Was ist NodeMap?
NodeMap ist ein Offline-Kartensystem auf Basis von Leaflet, React & Next.js, das über ein iFrame in
TALAS eingebettet wird.
📷 Beispielansicht:
![Kartenansicht](/screenshots/overview1.png)
➡️ [Mehr erfahren...](/docs/guide/project-structure.md)
---
## 2. Lokale Entwicklung
👉 [Setup-Anleitung](docs/guide/setup-dev.md)
- `git clone …`
- `npm install`
- `npm run dev`
- `.env.local` konfigurieren
👨‍💻 Wenn du das Projekt starten kannst → bist du bereit für Schritt 3!
---
## 3. Systemübersicht
🔁 Was lädt die Karte?
- POIs, Linien, Geräte, Rechte
- Datenquellen: Webservices (Port 80), eigene API (Port 3000)
🧠 Architektur-Doku:
➡️ [devices & Layerstruktur](docs/architecture/device-layer-connection-final.md)
---
## 4. Datenflüsse & API
📦 Die wichtigsten Schnittstellen:
- [Webservices (TALAS)](docs/guide/webservices.md)
- [Datenbankzugriff (Next.js)](docs/services/database/README.md)
- [Redux Struktur](docs/guide/redux-zustand.md)
---
## 5. Tipps
- 🔍 Häufige Fehler: [FAQ & Troubleshooting](docs/guide/faq.md)
- 🔄 Version wird automatisch über Git erhöht
- 🔐 `.env.production` nie ins Git committen!
---
## 6. Deployment
📤 Anleitung:
➡️ [Deployment-Guide](docs/guide/deployment.md)
- ZIP bauen
- Dienst starten oder `npm run start`
- Test via: `http://<ip>/talas5/...`
---