docs: delete appVersion , because auto increment in package.json and env files
This commit is contained in:
ISA
@@ -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)
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
<!-- /docs/config/appVersion.md -->
|
||||
|
||||
# 📦 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)
|
||||
@@ -1,67 +0,0 @@
|
||||
<!-- /docs/config/config.md -->
|
||||
|
||||
# ⚙️ 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)
|
||||
@@ -1,26 +0,0 @@
|
||||
<!-- /docs/config/layers.md -->
|
||||
|
||||
# 🗺️ 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)
|
||||
@@ -1,22 +0,0 @@
|
||||
<!-- /docs/config/urls.md -->
|
||||
|
||||
# 🌐 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)
|
||||
Reference in New Issue
Block a user