docs: add migrations, tests and vCard notes to README
This commit is contained in:
42
README.md
42
README.md
@@ -23,3 +23,45 @@ python app.py
|
|||||||
```
|
```
|
||||||
|
|
||||||
Das Formular ist dann unter http://127.0.0.1:5000/ erreichbar.
|
Das Formular ist dann unter http://127.0.0.1:5000/ erreichbar.
|
||||||
|
|
||||||
|
Migrations (Flask-Migrate / Alembic)
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
Das Projekt verwendet jetzt Flask-Migrate (Alembic) für Datenbank-Migrationen. Ablauf lokal:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# virtuelles Environment aktivieren
|
||||||
|
source .venv/bin/activate
|
||||||
|
|
||||||
|
# Migrationen initialisieren (nur einmal)
|
||||||
|
export FLASK_APP=app.py
|
||||||
|
flask db init
|
||||||
|
|
||||||
|
# Neue Migration auf Basis der Models erzeugen
|
||||||
|
flask db migrate -m "Beschreibung der Änderung"
|
||||||
|
|
||||||
|
# Migration anwenden
|
||||||
|
flask db upgrade
|
||||||
|
```
|
||||||
|
|
||||||
|
Hinweis: Wenn die Datenbank bereits Tabellen enthält, benutze `flask db stamp head`, damit Alembic den aktuellen Stand als angewendet markiert.
|
||||||
|
|
||||||
|
Tests
|
||||||
|
-----
|
||||||
|
|
||||||
|
Die Tests laufen mit pytest:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source .venv/bin/activate
|
||||||
|
python -m pytest -q
|
||||||
|
```
|
||||||
|
|
||||||
|
vCard Export
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Nach dem Absenden eines Anmeldeformulars wird eine vCard 4.0 im Ordner `vcards/` erzeugt. Dateiname-Muster:
|
||||||
|
|
||||||
|
```
|
||||||
|
Nachname_Vorname_<id>.vcf
|
||||||
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user