Reorganize repo layout
This commit is contained in:
38
README.md
38
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.
|
||||
|
||||
27
docs/README.md
Normal file
27
docs/README.md
Normal file
@@ -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.
|
||||
11
planning/README.md
Normal file
11
planning/README.md
Normal file
@@ -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.
|
||||
Reference in New Issue
Block a user