Stufe 0: Grundgerüst mit Rechenkern, Datenbank, Oberfläche und Docker-Betrieb
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AmyPfuNc4sCRfaF3oURXZz
This commit is contained in:
55
README.md
Normal file
55
README.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Betrieb – Betriebsführungsprogramm Schaarschmidt Holzbau
|
||||
|
||||
Nachfolger des Projektplaners V70 als Serverversion. Anforderungen und Ausbaustufen stehen im
|
||||
Lasten- und Pflichtenheft; dieses Repository setzt sie um, beginnend mit Stufe 0 (Grundlage).
|
||||
|
||||
## Aufbau
|
||||
|
||||
| Ordner | Inhalt |
|
||||
|---|---|
|
||||
| `src/domain` | Rechenkern ohne Datenbank: Arbeitstage und Feiertage SH, Beträge in Cent, Umsatzsteuer, Zahlungsplan, Liquidität |
|
||||
| `src/server` | Server (Fastify), Datenbankzugriff, Migrationen in `migrations/` |
|
||||
| `src/web` | Oberfläche im Browser |
|
||||
| `test` | Automatische Tests; `api.test.ts` braucht eine Testdatenbank |
|
||||
| `deploy` | Betrieb auf dem Server: Docker Compose, Proxy, Update und Rückkehr |
|
||||
| `backup` | Container für die nächtliche Sicherung |
|
||||
|
||||
Grundregeln: Beträge immer als ganze Cent, Datumsangaben als `JJJJ-MM-TT`, Verknüpfungen nur über IDs.
|
||||
Jede Tabelle hat `angelegt_am`, `geaendert_am`, `geaendert_von`; jede Änderung landet in `protokoll`.
|
||||
|
||||
## Entwickeln
|
||||
|
||||
Im Dev Container (VS Code oder GitHub Codespaces) ist alles eingerichtet:
|
||||
|
||||
```sh
|
||||
npm run dev # Server auf http://localhost:3000, Datenbank aus dem Dev Container
|
||||
npm test # alle Tests
|
||||
npm run typecheck
|
||||
```
|
||||
|
||||
Ohne Dev Container: Node 22 und PostgreSQL 16, dann `DATABASE_URL` und für die API-Tests
|
||||
`TEST_DATABASE_URL` setzen. Datenbankänderungen nur als neue Datei in `src/server/migrations`
|
||||
(`002_….sql`, `003_….sql`); sie laufen beim Start automatisch.
|
||||
|
||||
## Release
|
||||
|
||||
1. Änderung im eigenen Zweig, Pull Request, Prüfung muss grün sein.
|
||||
2. Nach dem Zusammenführen `CHANGELOG.md` ergänzen und einen Tag setzen: `git tag v1.0.0 && git push --tags`.
|
||||
3. GitHub baut daraus das Image `ghcr.io/<besitzer>/<repo>:1.0.0`.
|
||||
4. Auf dem Server erst die Testumgebung, nach Freigabe die Produktion:
|
||||
|
||||
```sh
|
||||
cd deploy
|
||||
./update.sh test 1.0.0
|
||||
./update.sh produktion 1.0.0
|
||||
./zurueck.sh produktion # falls etwas schiefgeht: vorige Version und Sicherung
|
||||
```
|
||||
|
||||
## Server einrichten (einmalig)
|
||||
|
||||
1. Virtueller Server in Deutschland mit Docker, zwei DNS-Einträge (Produktion und Test) auf seine Adresse.
|
||||
2. Repository auf den Server holen, `deploy/.env.beispiel` nach `deploy/.env` kopieren und ausfüllen.
|
||||
3. Beim Server bei `ghcr.io` anmelden (Lesezugriff auf das Image), dann `cd deploy && docker compose up -d`.
|
||||
|
||||
Sicherung: jede Nacht und vor jedem Update, 30 Tage aufbewahrt, Kopie per WebDAV in die Nextcloud.
|
||||
Eine Sicherung von Hand: `docker compose exec backup sicherung`.
|
||||
Reference in New Issue
Block a user