45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
ID: DOC_000013 | Version: 0.2.1 | Status: Draft
|
|
By: Codex (GPT-5)
|
|
|
|
# Development
|
|
|
|
## Repository-Struktur (Kurz)
|
|
- `backend/`: FastAPI-App, Auth, Update-Logik, Templates, Static Assets.
|
|
- `scripts/`: Install/Deploy/Update/Helper-Skripte.
|
|
- `systemd/`: Beispiel-Unit.
|
|
- `docs/architecture/`: OpenAPI-Spezifikation fuer Update-Service.
|
|
- `docs/`: Dokumentation.
|
|
- `assets/`: Branding und Design.
|
|
- `sk.sh`: Legacy-CLI.
|
|
|
|
## Lokales Setup
|
|
```bash
|
|
./scripts/create_venv.sh
|
|
source .venv/bin/activate
|
|
./scripts/run.sh
|
|
```
|
|
Standard: `0.0.0.0:80`. Fuer andere Ports:
|
|
```bash
|
|
HOST=127.0.0.1 PORT=8000 ./scripts/run.sh
|
|
```
|
|
|
|
## Tests und Lint
|
|
Im Repo sind keine automatisierten Tests enthalten. Verfuegbare Checks:
|
|
- Bash-Syntax: `bash -n sk.sh`
|
|
- ShellCheck: `shellcheck sk.sh`
|
|
|
|
## Coding Conventions
|
|
- Bash 4+, `set -euo pipefail` in neuen Skripten.
|
|
- Python: FastAPI-Patterns, klare Modultrennung (Auth, Actions, Update, OIDC).
|
|
|
|
## Beitrag und Workflow
|
|
- Arbeite mit Feature-Branches.
|
|
- Aktualisiere `VERSION`, Doku-Header und `CHANGELOG.md` gemaess SOP.
|
|
- PRs sollten Verhalten, Risiken und manuelle Tests beschreiben.
|
|
|
|
## CI/CD
|
|
Aktuell keine CI/CD-Pipeline im Repository definiert.
|
|
|
|
## Legacy/Interna
|
|
- `SKD_UPDATE_URL` und `SKD_UPDATE_STATUS_URL` sind in `backend/settings.py` noch vorhanden, werden aber im aktuellen Code nicht genutzt.
|