From ecbbba8dbb105b62b0972ea6de075faf48e75456 Mon Sep 17 00:00:00 2001 From: ISA Date: Tue, 24 Jun 2025 09:43:15 +0200 Subject: [PATCH] docs: delete appVersion , because auto increment in package.json and env files --- .env.development | 2 +- .env.production | 2 +- docs/README.md | 1 - docs/config/README.md | 28 ++++------------ docs/config/appVersion.md | 21 ------------ docs/config/config.md | 67 --------------------------------------- docs/config/layers.md | 26 --------------- docs/config/urls.md | 22 ------------- docs/guide/setup-dev.md | 2 +- package-lock.json | 4 +-- package.json | 2 +- 11 files changed, 13 insertions(+), 164 deletions(-) delete mode 100644 docs/config/appVersion.md delete mode 100644 docs/config/config.md delete mode 100644 docs/config/layers.md delete mode 100644 docs/config/urls.md diff --git a/.env.development b/.env.development index f4686987b..84d2aeaf7 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.286 +NEXT_PUBLIC_APP_VERSION=1.1.287 diff --git a/.env.production b/.env.production index 52d043b4f..2ba36137c 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.286 \ No newline at end of file +NEXT_PUBLIC_APP_VERSION=1.1.287 \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 1a2dd4e3f..d6a705e25 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,7 +24,6 @@ Entwicklung, Architekturverständnis und Erweiterung. ### ⚙️ Konfiguration -- [appVersion.js](config/appVersion.md) - [Konfiguration: config.js](config/config.md) - [Layer-Konfiguration](config/layers.md) - [Allgemeine Übersicht](config/README.md) diff --git a/docs/config/README.md b/docs/config/README.md index 3f38b93cb..179d30ebf 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2,23 +2,8 @@ # ⚙️ Konfigurationsübersicht (/config) -Dieses Verzeichnis enthält zentrale Konfigurationsdateien, die das Verhalten der gesamten App -steuern. -Hier sind die wichtigsten Dateien, ihre Aufgaben und Verlinkungen zur Dokumentation: - ---- - -## 📦 [`appVersion.js`](./appVersion.md) - -- Definiert die aktuelle Version der App (`APP_VERSION`) -- Wird z. B. im `VersionInfoModal` angezeigt - ---- - -## 🗺️ [`layers.js`](./layers.md) - -- Enthält alle Leaflet-Layergruppen für die Kartenanzeige -- Zentrale Steuerung der aktiven Layer: TALAS, GMA, Cisco, etc. +Dieses Verzeichnis enthält die zentrale Pfad-Konfigurationsdatei, die für konsistente +URL-Generierung in NodeMap zuständig ist. --- @@ -26,14 +11,15 @@ Hier sind die wichtigsten Dateien, ihre Aufgaben und Verlinkungen zur Dokumentat - Berechnet den Basis-Pfad aus `.env.production` oder `.env.development` - Liefert `BASE_URL`, z. B. `/talas5` +- Wird in der gesamten App zur dynamischen URL-Erzeugung verwendet --- -## 🌐 [`urls.js`](./urls.md) +Diese Konfiguration stellt sicher, dass NodeMap unabhängig von Hostname, Port oder +Verzeichnisstruktur funktioniert. -- Erzeugt dynamisch API- und Tile-URLs -- Verwendet `window.location.origin` → keine statischen Ports notwendig +📄 Pfad: `/config/paths.js` --- -Diese Konfiguration macht das Projekt flexibel für mehrere Hosting-Umgebungen. +[Zurück zur Übersicht](../README.md) diff --git a/docs/config/appVersion.md b/docs/config/appVersion.md deleted file mode 100644 index 97cde7218..000000000 --- a/docs/config/appVersion.md +++ /dev/null @@ -1,21 +0,0 @@ - - -# 📦 appVersion.js - -Diese Datei exportiert die aktuelle App-Version, die an mehreren Stellen in der UI angezeigt werden -kann – z. B. im `VersionInfoModal`. - -## Inhalt - -```js -export const APP_VERSION = "1.1.193"; -``` - -## Verwendung - -- Im Footer oder Info-Fenster -- Vergleich von Client- vs. Serverversion - ---- - -[Zurück zur Übersicht](../README.md) diff --git a/docs/config/config.md b/docs/config/config.md deleted file mode 100644 index 4adf59563..000000000 --- a/docs/config/config.md +++ /dev/null @@ -1,67 +0,0 @@ - - -# ⚙️ config.js – zentrale Konfiguration und Umgebungssteuerung - -## Zweck - -Diese Datei enthält zentrale Konfigurationswerte, die abhängig von der Umgebung -(Entwicklung oder Produktion) dynamisch erzeugt werden. - ---- - -## Ersetzungen von Umgebungsvariablen - -Vorher wurden folgende `.env.production` / `.env.development` Variablen verwendet: - -- `NEXT_PUBLIC_BASE_URL` -- `NEXT_PUBLIC_SERVER_URL` - -Diese wurden ersetzt durch dynamische Berechnung anhand von: - -```env -NEXT_PUBLIC_API_PORT_MODE=dev -``` - ---- - -## Dynamische Berechnung von `serverURL` - -Die Konfiguration entscheidet anhand des Modus: - -```js -const mode = process.env.NEXT_PUBLIC_API_PORT_MODE; - -const serverURL = - mode === "dev" - ? `${window.location.protocol}//${window.location.hostname}:80` - : `${window.location.origin}`; -``` - -→ Dadurch funktioniert der Code ohne Anpassung bei IP-/Server-Wechseln oder Portunterschieden. - ---- - -## Konfigurationswerte - -- `USE_MOCK_API`: aktiviert lokale Mock-Daten -- `serverURL`: Basis für Webservice-Aufrufe (`/talas5/...`) -- `mapGisStationsStaticDistrictUrl`: komplette zusammengesetzte URL -- `useMockStationData`: true/false aus `.env.production` / `.env.development` - ---- - -## Vorteile - -| Punkt | Vorteil | -| ------------------------------- | ---------------------------------------- | -| Keine festen IPs oder Ports | ✅ Weniger Fehler, einfacher Umzug | -| Einheitlich mit anderen Dateien | ✅ Gleiche Struktur wie Webservice-Setup | -| Lesbar & leicht anpassbar | ✅ Auch ohne Doku sofort verständlich | - ---- - -📄 Pfad: `/docs/frontend/config/config.md` - ---- - -[Zurück zur Übersicht](../README.md) diff --git a/docs/config/layers.md b/docs/config/layers.md deleted file mode 100644 index 79d0daee8..000000000 --- a/docs/config/layers.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# 🗺️ layers.js - -Diese Datei definiert alle verfügbaren Leaflet-Layergruppen im Projekt. -Sie werden global als `MAP_LAYERS` exportiert und enthalten alle Systemtypen (TALAS, GMA, OTDR -etc.). - -## Struktur - -```js -export const MAP_LAYERS = { - TALAS: new L.layerGroup(), - ... - lineLayer: new L.LayerGroup(), -}; -``` - -## Verwendung - -- Initialisierung der Leaflet-Karte -- Zuweisung von Markern und Linien - ---- - -[Zurück zur Übersicht](../README.md) diff --git a/docs/config/urls.md b/docs/config/urls.md deleted file mode 100644 index dc1505e09..000000000 --- a/docs/config/urls.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# 🌐 urls.js - -Diese Datei berechnet dynamisch URLs basierend auf `window.location.origin`. -Alle Endpunkte (API, Tiles, Server) werden ohne Port oder Hardcoding erzeugt. - -## Exportierte Konstanten - -- `BASE_URL` → `/api` -- `SERVER_URL` → Hostname ohne Port (für Links) -- `PROXY_TARGET` → z. B. `http://hostname:4000` -- `OFFLINE_TILE_LAYER` → Offline-Kachelpfad -- `MAP_TILES_LAYER` → Alias für `OFFLINE_TILE_LAYER` - -## Hinweis - -Alle Berechnungen erfolgen nur **clientseitig** (`typeof window !== "undefined"`). - ---- - -[Zurück zur Übersicht](../README.md) diff --git a/docs/guide/setup-dev.md b/docs/guide/setup-dev.md index fa43873bd..d41c528ae 100644 --- a/docs/guide/setup-dev.md +++ b/docs/guide/setup-dev.md @@ -34,7 +34,7 @@ NEXT_PUBLIC_USE_MOCKS=true Datei `.env.development` mit Inhalten wie: ``` -NEXT_PUBLIC_API_URL=http://localhost:3001 +NEXT_PUBLIC_API_URL=http://localhost:3000 NEXT_PUBLIC_USE_MOCKS=true ``` diff --git a/package-lock.json b/package-lock.json index 2097530ae..bb1c32e5d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "nodemap", - "version": "1.1.286", + "version": "1.1.287", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "nodemap", - "version": "1.1.286", + "version": "1.1.287", "dependencies": { "@emotion/react": "^11.13.3", "@emotion/styled": "^11.13.0", diff --git a/package.json b/package.json index c749bfb7f..f28cb0a04 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nodemap", - "version": "1.1.286", + "version": "1.1.287", "dependencies": { "@emotion/react": "^11.13.3", "@emotion/styled": "^11.13.0",