maddin
62 lines
1.4 KiB
Markdown
62 lines
1.4 KiB
Markdown
# Stundenfuchs
|
|
|
|
Stundenfuchs ist eine FastAPI-Anwendung zur Erfassung von Arbeitszeiten mit Benutzerkonten, Wochen- und Monatsansicht, Exportfunktionen und einer serverseitig abgesicherten Web-UI.
|
|
|
|
## Features
|
|
|
|
- Registrierung und Login
|
|
- Benutzerbezogene Datentrennung
|
|
- Wochen- und Monatsansicht
|
|
- Excel-, PDF- und Backup-Export
|
|
- Backup-Import
|
|
- Urlaub, Feiertage und Krankheitstage
|
|
- Mehrfacheingaben für Zeiträume
|
|
- E-Mail-Verifikation, Passwort-Reset und MFA
|
|
- Admin-Bereich für Benutzer- und Systemeinstellungen
|
|
|
|
## Stack
|
|
|
|
- FastAPI
|
|
- SQLAlchemy
|
|
- SQLite
|
|
- Jinja2 Templates
|
|
- Vanilla JavaScript
|
|
- CSS mit zentralen Design-Tokens
|
|
|
|
## Lokal starten
|
|
|
|
```bash
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -r requirements.txt
|
|
cp .env.example .env
|
|
python -m app.main
|
|
```
|
|
|
|
Danach ist die App unter `http://localhost:8000` erreichbar.
|
|
|
|
## Docker
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
docker compose up -d --build
|
|
```
|
|
|
|
## Qualitätssicherung
|
|
|
|
```bash
|
|
make policy
|
|
make lint
|
|
make test
|
|
make ci
|
|
```
|
|
|
|
## Dokumentation
|
|
|
|
- Entwicklung: `docs/DEVELOPMENT.md`
|
|
- Sicherheit: `docs/SECURITY.md`
|
|
|
|
## Hinweise zur Veröffentlichung
|
|
|
|
Dieses Public-Repository enthält bewusst keine produktionsspezifische Infrastruktur, keine internen Betriebsanweisungen und keine Stage-/Live-Dokumentation. Für eine öffentliche Veröffentlichung sollte zusätzlich eine passende `LICENSE` ergänzt werden.
|