Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 2m7s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 2m11s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 2m16s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 2m18s
CI / PHP 8.3 / mysql:8.0 (pull_request) Failing after 2m49s
CI / PHP 8.4 / mysql:8.0 (pull_request) Failing after 2m46s
CI / PHP 8.3 / mysql:8.4 (pull_request) Failing after 2m41s
CI / PHP 8.4 / mysql:8.4 (pull_request) Failing after 2m33s
CI / Build-Artefakte aktuell (pull_request) Successful in 1m0s
- Theme in den Einstellungen (Entwurf/veröffentlicht), Übernahme der Einstellungen aus Phase 0; statische CSS-Datei mit Hash beim Veröffentlichen - Logos hell/dunkel, Signet, App-Symbol → Favicon, Homescreen-Symbole, Web-App-Manifest; SVG-Bereinigung - Markenfarbe exakt, zweite Akzentfarbe, Kopfleiste hell/Marke/dunkel, Kontrastprüfung (WCAG AA) mit automatisch lesbarer Linkfarbe - Lokale Schriften (Latein), Überschriften-Schrift, eigene WOFF2-Schrift, Ecken, Dichte, Dunkelmodus-Regel - Anmeldeseite (geteilt/zentriert, Bild, Texte), Fußzeile, E-Mails im Design - Admin: Live-Vorschau (Startseite, Anmeldung, Beispielseite; hell/dunkel), Veröffentlichen, Verwerfen, Export/Import, Zurücksetzen, eigenes CSS - Admin-Bereich übernimmt Logo, Farbe und Favicon; Whitelabel Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
75 lines
3.3 KiB
Markdown
75 lines
3.3 KiB
Markdown
# Mitarbeit an Inhaus
|
||
|
||
## Grundsatz: Das Repository ist das Release
|
||
|
||
Kunden installieren und aktualisieren Inhaus ohne Shell – auch auf Shared
|
||
Webhosting. Der Self-Updater lädt den Stand des Branches als ZIP
|
||
(`main` = Kanal „stable“, `develop` = Kanal „development“).
|
||
Deshalb liegen im Repository auch alle Build-Artefakte:
|
||
|
||
| Verzeichnis | Inhalt | erzeugt durch |
|
||
|---|---|---|
|
||
| `vendor/` | PHP-Pakete **ohne** Entwicklungsabhängigkeiten | `bin/build` |
|
||
| `public/build/` | kompiliertes Portal-Frontend (Vue, Tailwind, shadcn-vue) | `bin/build` |
|
||
| `public/css/filament`, `public/js/filament`, `public/fonts/filament` | Filament-Assets | `php artisan filament:upgrade` (läuft bei `composer install`) |
|
||
|
||
Die CI prüft, dass diese Artefakte zum Quellcode passen.
|
||
|
||
## Entwicklungsumgebung
|
||
|
||
Voraussetzungen: PHP 8.3 (Extensions: intl, zip, gd, pdo_mysql, bcmath, exif),
|
||
Composer, Node 24, MySQL ≥ 8.0 oder MariaDB ≥ 10.6 – oder Docker
|
||
(`docker compose up -d`, siehe `docker-compose.yml`).
|
||
|
||
**Entwicklungspakete gehören nach `vendor-dev/`**, nicht nach `vendor/`.
|
||
`bootstrap/autoload.php` nimmt automatisch `vendor-dev/`, wenn es existiert.
|
||
|
||
```bash
|
||
export COMPOSER_VENDOR_DIR=vendor-dev # am besten dauerhaft in die Shell-Konfiguration
|
||
composer install
|
||
cp .env.example .env && php artisan key:generate
|
||
php artisan migrate --seed # Demo-Konto: admin@example.com / password
|
||
npm ci && npm run dev # oder: npm run build
|
||
```
|
||
|
||
Tests laufen gegen MySQL/MariaDB (Datenbank `inhaus_test`, Zugang wie in `.env`):
|
||
|
||
```bash
|
||
vendor-dev/bin/phpunit
|
||
vendor-dev/bin/pint
|
||
```
|
||
|
||
Neue Pakete immer mit gesetztem `COMPOSER_VENDOR_DIR=vendor-dev` hinzufügen
|
||
und danach `bin/build` ausführen, damit `vendor/` nachzieht.
|
||
|
||
## Ablauf für jede Änderung
|
||
|
||
1. `CHANGELOG.md`: neuen Abschnitt `## MAJOR.MINOR.PATCH` ganz oben ergänzen –
|
||
kurze deutsche Stichpunkte für Anwenderinnen und Anwender, keine Commit-Texte
|
||
2. `App\Version::VERSION` in `app/Version.php` anheben
|
||
(Patch = Fehlerbehebung, Minor = neue Funktion)
|
||
3. Tests grün (`vendor-dev/bin/phpunit`), Code formatiert (`vendor-dev/bin/pint`)
|
||
4. `bin/build` ausführen und `vendor/` sowie `public/build/` mitcommitten
|
||
5. Merge in `develop` bzw. `main` – damit ist die Fassung sofort über den
|
||
Self-Updater verfügbar
|
||
|
||
## Konventionen
|
||
|
||
- Oberflächentexte auf Deutsch mit echten Umlauten; technische Schlüssel,
|
||
Routennamen, Tabellen und Spalten in ASCII/Englisch
|
||
- Nur Funktionen nutzen, die MySQL **und** MariaDB beherrschen
|
||
- Kein Node, kein Shell-Aufruf und kein Dauerprozess auf dem Server voraussetzen
|
||
- Keine externen Ressourcen (CDNs, Google Fonts, Avatar-Dienste) einbinden – DSGVO
|
||
- UI-Bausteine: shadcn-vue-Komponenten liegen als eigener Code unter
|
||
`resources/js/components/ui` (neue mit `npx shadcn-vue@latest add …`).
|
||
Farben nur über die Tokens (`bg-brand`, `text-brand-text`, `bg-card`,
|
||
`text-muted-foreground` …), nie fest verdrahtet – sonst greift das Branding nicht
|
||
- N+1-Abfragen vermeiden: `Model::preventLazyLoading()` ist außerhalb der
|
||
Produktion aktiv
|
||
|
||
## Schriften
|
||
|
||
Die mitgelieferten Schriften kommen aus `@fontsource`-Paketen, eingebunden nur
|
||
mit den Zeichensätzen Latein und Latein-Erweitert. Nach dem Hinzufügen einer
|
||
Schrift `python3 scripts/generate-fonts-css.py` ausführen und die Schrift in
|
||
`App\Support\Theme\Fonts` eintragen.
|