Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AmyPfuNc4sCRfaF3oURXZz
56 lines
2.8 KiB
Markdown
56 lines
2.8 KiB
Markdown
# 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. Auf dem Server baut `update.sh` das Image aus diesem Tag (git.deichnet.com), eine Registry ist nicht nötig.
|
||
4. Auf dem Server (vorerst nur Produktion, ohne Testumgebung):
|
||
|
||
```sh
|
||
cd deploy
|
||
./update.sh 1.0.0
|
||
./zurueck.sh # falls etwas schiefgeht: vorige Version und Sicherung
|
||
```
|
||
|
||
## Server einrichten (einmalig)
|
||
|
||
1. Server mit Docker und git; ein Reverse Proxy (HAProxy) mit TLS leitet an `APP_ADRESSE:APP_PORT` aus `.env` weiter.
|
||
2. Repository von git.deichnet.com auf den Server klonen, `deploy/.env.beispiel` nach `deploy/.env` kopieren und ausfüllen.
|
||
3. `cd deploy && ./update.sh 0.53.0` baut das Image und startet Programm, Datenbank und Sicherung (`docker compose up -d`). Die Daten liegen in `deploy/data/db` und `deploy/data/backup`. HTTPS macht der vorhandene HAProxy; er setzt `X-Forwarded-Proto: https`.
|
||
4. Beim ersten Aufruf fragt das Programm nach dem Inhaber und dem Einrichtungscode (aus `.env` oder `docker compose logs app | grep Einrichtungscode`). Alle weiteren Zugänge legt der Inhaber unter „Benutzer“ an.
|
||
|
||
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`.
|