From 4c15f0685c58224e74a7582272cc9e693d6bbb85 Mon Sep 17 00:00:00 2001 From: madgerm Date: Mon, 2 Feb 2026 23:57:09 +0100 Subject: [PATCH] Reorganize repo layout --- README.md | 38 +++++++++------------- docs/README.md | 27 +++++++++++++++ planning/README.md | 11 +++++++ {public => web/public}/assets/starfield.js | 0 {public => web/public}/assets/style.css | 0 {public => web/public}/assets/ui.js | 0 {public => web/public}/index.php | 0 {src => web/src}/partials/menue-foot.php | 0 {src => web/src}/partials/menue-top.php | 0 {src => web/src}/partials/menue.php | 0 {src => web/src}/partials/menue2.php | 0 {src => web/src}/partials/ressourcen.php | 0 {src => web/src}/partials/site.php | 0 13 files changed, 53 insertions(+), 23 deletions(-) create mode 100644 docs/README.md create mode 100644 planning/README.md rename {public => web/public}/assets/starfield.js (100%) rename {public => web/public}/assets/style.css (100%) rename {public => web/public}/assets/ui.js (100%) rename {public => web/public}/index.php (100%) rename {src => web/src}/partials/menue-foot.php (100%) rename {src => web/src}/partials/menue-top.php (100%) rename {src => web/src}/partials/menue.php (100%) rename {src => web/src}/partials/menue2.php (100%) rename {src => web/src}/partials/ressourcen.php (100%) rename {src => web/src}/partials/site.php (100%) diff --git a/README.md b/README.md index 5a22a55..98840a1 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,19 @@ -# Space UI Demo v2 (PHP + CSS + JS) +# Space Theme (Repository layout) -## Übersicht -Diese Demo zeigt eine HUD-artige Navigation mit statischem Hauptmenü, kontextabhängiger Subnav, Sticky-Ressourcenleiste, Toasts und einem generischen Content-Bereich. Das HTML wird vom zentralen Entry-Point `public/index.php` zusammengesetzt, die einzelnen Bausteine liegen als Partial-Templates in `src/partials`. +## Ziel +Alles, was später auf den Webserver gehört, lebt unter `web/`. Die anderen Ordner dokumentieren Planung und Infos, die nicht direkt ausgeliefert werden. -## Verzeichnisstruktur -- `public/`: Dokumentenwurzel, in der `index.php` sitzt und auf die Assets (`assets/`) zugreift. Alles, was vom Webserver ausgeliefert wird, gehört hierhin. -- `public/assets/`: CSS- und JS-Dateien (`style.css`, `ui.js`, `starfield.js`). -- `src/partials/`: Menü-, Footer-, Ressourcendarstellung und Content-Renderer, die `public/index.php` inkludiert. +## Struktur +- `web/public/`: Webserver-Entry-Point und Assets (CSS/JS) für die HUD-Demo. +- `web/src/partials/`: Die PHP-Partial-Templates für Menüs, Ressourcen und Content. +- `docs/`: Projektdokumentation; siehe `docs/README.md` für Details zur Anwendung. +- `planning/`: Freifläche für Skizzen, Notizen oder Quelltext, der nicht ins Webroot gehört. -## Layout-Highlights -- **Sidebar**: Hauptmenü (links) mit statischem Link-Set plus optionaler Planetenliste auf der Unterseite. -- **Topbar & Notification-Dropdown**: Anzeige, Actions & Test-Toast-Button. -- **Subnav**: Mittig platzierte Tabs (Kontextmenü) basierend auf dem `$subnav`-Array in `public/index.php`. -- **Ressourcenleiste**: Sticky-Komponente unterhalb der Subnav (`src/partials/ressourcen.php`). -- **Content**: Demo-Inhalte aus `src/partials/site.php`, die Sections und Subpages simulieren. -- **Footer**: Menü-Links und optionaler Admin-Chip, gesteuert über `$isAdmin`. +## Entwicklung +1. `cd /path/to/Space-Theme` +2. `php -S localhost:8000 -t web/public` +3. Öffne `http://localhost:8000/index.php?s=overview&p=dashboard` -## Lokale Entwicklung -1. `cd /path/to/Space-Theme`. -2. `php -S localhost:8000 -t public` (setzt die Dokumentenwurzel auf `public/`). -3. Öffne `http://localhost:8000/index.php` und wechsle z. B. über `?s=build&p=demolish` die Sections. - -## Hinweise -- Die PHP-Session (`session_start()`) im Entry-Point dient Flash-Toasts und Alert-Messages. -- Die Partial-Templates erwarten die Variablen `$section`, `$sub`, `$planet` und greifen über `$partialsPath` aufeinander zu. -- Performance-/Alert-Profile werden über `sessionStorage` bzw. `localStorage` gesteuert – die Buttons in `public/assets/ui.js` sorgen für die Visualisierung. +## Weitere Infos +- Die ausführliche Demo-Beschreibung und Abläufe stehen in `docs/README.md`. +- Trage Planungsnotizen und zusätzliche Quellen in `planning/` ein, damit sie nicht mit in `web/` landen. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..f782c47 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,27 @@ +# Space UI Demo v2 (PHP + CSS + JS) + +## Übersicht +Diese Demo zeigt eine HUD-artige Navigation mit statischem Hauptmenü, kontextabhängiger Subnav, Sticky-Ressourcenleiste, Toasts und einem generischen Content-Bereich. Das HTML wird vom zentralen Entry-Point `public/index.php` zusammengesetzt, die einzelnen Bausteine liegen als Partial-Templates in `src/partials`. + +## Verzeichnisstruktur +- `web/public/`: Dokumentenwurzel, in der der Entry Point sitzt und auf die Assets unter `web/public/assets/` zugreift. Alles, was ausgeliefert wird, gehört hierhin. +- `web/public/assets/`: CSS- und JS-Dateien (`style.css`, `ui.js`, `starfield.js`), die das HUD und den Starfield-Canvas bedienen. +- `web/src/partials/`: Menü-, Footer-, Ressourcendarstellung und Content-Renderer, die `web/public/index.php` inkludiert. + +## Layout-Highlights +- **Sidebar**: Hauptmenü (links) mit statischem Link-Set plus optionaler Planetenliste auf der Unterseite. +- **Topbar & Notification-Dropdown**: Anzeige, Actions & Test-Toast-Button. +- **Subnav**: Mittig platzierte Tabs (Kontextmenü) basierend auf dem `$subnav`-Array in `public/index.php`. +- **Ressourcenleiste**: Sticky-Komponente unterhalb der Subnav (`src/partials/ressourcen.php`). +- **Content**: Demo-Inhalte aus `src/partials/site.php`, die Sections und Subpages simulieren. +- **Footer**: Menü-Links und optionaler Admin-Chip, gesteuert über `$isAdmin`. + +## Lokale Entwicklung +1. `cd /path/to/Space-Theme`. +2. `php -S localhost:8000 -t web/public` (setzt die Dokumentenwurzel auf `web/public/`). +3. Öffne `http://localhost:8000/index.php` und wechsle z. B. über `?s=build&p=demolish` die Sections. + +## Hinweise +- Die PHP-Session (`session_start()`) im Entry-Point dient Flash-Toasts und Alert-Messages. +- Die Partial-Templates erwarten die Variablen `$section`, `$sub`, `$planet` und greifen über `$partialsPath` aus `web/public/index.php` aufeinander zu. +- Performance-/Alert-Profile werden über `sessionStorage` bzw. `localStorage` gesteuert – die Buttons in `public/assets/ui.js` sorgen für die Visualisierung. diff --git a/planning/README.md b/planning/README.md new file mode 100644 index 0000000..36507b9 --- /dev/null +++ b/planning/README.md @@ -0,0 +1,11 @@ +# Planung und Quellen + +Dieser Ordner fasst Ideen, Skizzen, Kopien von Mockups und andere Rohdaten zusammen, die nicht im Webroot liegen sollen. + +Beispiele: +- Notizen zur UI-Story oder zum Menüfluss +- Wireframes im SVG/PNG-Format +- Prototyp-Dateien (.psd, .xd, .fig, ...) +- Auszug aus Konzeptpapiere oder Projekt-Backlog + +Trage neue Einträge ein, bevor du sie weiterverarbeitest und eventuell in `web/` übernimmst. diff --git a/public/assets/starfield.js b/web/public/assets/starfield.js similarity index 100% rename from public/assets/starfield.js rename to web/public/assets/starfield.js diff --git a/public/assets/style.css b/web/public/assets/style.css similarity index 100% rename from public/assets/style.css rename to web/public/assets/style.css diff --git a/public/assets/ui.js b/web/public/assets/ui.js similarity index 100% rename from public/assets/ui.js rename to web/public/assets/ui.js diff --git a/public/index.php b/web/public/index.php similarity index 100% rename from public/index.php rename to web/public/index.php diff --git a/src/partials/menue-foot.php b/web/src/partials/menue-foot.php similarity index 100% rename from src/partials/menue-foot.php rename to web/src/partials/menue-foot.php diff --git a/src/partials/menue-top.php b/web/src/partials/menue-top.php similarity index 100% rename from src/partials/menue-top.php rename to web/src/partials/menue-top.php diff --git a/src/partials/menue.php b/web/src/partials/menue.php similarity index 100% rename from src/partials/menue.php rename to web/src/partials/menue.php diff --git a/src/partials/menue2.php b/web/src/partials/menue2.php similarity index 100% rename from src/partials/menue2.php rename to web/src/partials/menue2.php diff --git a/src/partials/ressourcen.php b/web/src/partials/ressourcen.php similarity index 100% rename from src/partials/ressourcen.php rename to web/src/partials/ressourcen.php diff --git a/src/partials/site.php b/web/src/partials/site.php similarity index 100% rename from src/partials/site.php rename to web/src/partials/site.php