Add repo hygiene rules and ignore secrets
This commit is contained in:
32
README.md
32
README.md
@@ -7,12 +7,38 @@ Alles, was später auf den Webserver gehört, lebt unter `web/`. Die anderen Ord
|
||||
- `web/desktop/`: Desktop-geeigneter Build mit eigenem `public/` (Entry-Point) und `src/partials/`.
|
||||
- `web/mobile/`: Mobile-Version (aktuell ein Spiegel des Desktop-Builds; anpassbar für responsive Varianten).
|
||||
- `docs/`: Projektdokumentation; siehe `docs/README.md` für Details zur Anwendung.
|
||||
- `docs/game_rulebook_v1_2.md`: **SSOT** für Regeln, Generator, Blueprints und Permissions.
|
||||
- `planning/`: Freifläche für Skizzen, Notizen oder Quelltext, der nicht ins Webroot gehört.
|
||||
- `server/`: Slim-Backend (PSR-4/7/15/11), API-Endpunkte und Tests.
|
||||
- `config/`: JSON-Konfigurationen (Planetklassen, Rassen, Gebäude-Blueprints).
|
||||
|
||||
## Entwicklung
|
||||
1. `cd /path/to/Space-Theme`
|
||||
2. `php -S localhost:8000 -t web/desktop/public`
|
||||
3. Öffne `http://localhost:8000/index.php?s=overview&p=dashboard` (für mobile Tests `-t web/mobile/public`).
|
||||
1. `cp .env.example .env`
|
||||
2. `docker compose up -d`
|
||||
3. `psql -h 127.0.0.1 -U <DB_USER> -c \"CREATE DATABASE <DB_TEST_NAME>\"` (nur einmalig)
|
||||
4. `cd server && composer install`
|
||||
5. `php db/migrate.php`
|
||||
6. `php db/seed.php`
|
||||
7. `vendor/bin/phpunit`
|
||||
8. `php -S localhost:8000 -t web/desktop/public`
|
||||
9. Öffne `http://localhost:8000/index.php?s=overview&p=dashboard` (für mobile Tests `-t web/mobile/public`).
|
||||
|
||||
## Konfiguration (.env)
|
||||
Die Datei `.env.example` enthält **Platzhalter** (`change-me`). Diese Werte **müssen** vor einem Produktivbetrieb ersetzt werden.
|
||||
|
||||
Benötigte Variablen:
|
||||
- `APP_ENV`
|
||||
- `DEV_MODE`
|
||||
- `DEV_USER_ID`
|
||||
- `DB_HOST`
|
||||
- `DB_PORT`
|
||||
- `DB_NAME`
|
||||
- `DB_TEST_NAME`
|
||||
- `DB_USER`
|
||||
- `DB_PASS`
|
||||
|
||||
## Repo-Hygiene
|
||||
Vor dem Commit prüfen: **keine Secrets im Diff**.
|
||||
|
||||
## Weitere Infos
|
||||
- Die ausführliche Demo-Beschreibung und Abläufe stehen in `docs/README.md`.
|
||||
|
||||
Reference in New Issue
Block a user