README.md aktualisiert: Neue Features und Version 1.0.1 dokumentiert
This commit is contained in:
230
README.md
230
README.md
@@ -1,229 +1,107 @@
|
|||||||
# medisoftware Kundensuche
|
# medisoftware Kundensuche
|
||||||
|
|
||||||
Eine Flask-basierte Webanwendung zur Suche in Kundendaten aus einer CSV-Datei.
|
Eine Webanwendung zur Suche in Kundendaten der medisoftware.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Live-Suche während der Eingabe
|
- Live-Suche in Kundendaten
|
||||||
- Spezifische Suchfelder für:
|
- Spezifische Suchfelder für:
|
||||||
|
- Name
|
||||||
|
- Ort
|
||||||
- Kundennummer
|
- Kundennummer
|
||||||
- Name (Vor- und Nachname)
|
|
||||||
- Fachrichtung
|
- Fachrichtung
|
||||||
- Ort
|
- Telefonnummer
|
||||||
- Allgemeine Suche über alle Felder
|
- Allgemeine Suche über alle Felder
|
||||||
- Klickbare Links für:
|
- Klickbare Telefonnummern
|
||||||
- Telefonnummern (tel:)
|
- Klickbare E-Mail-Adressen
|
||||||
- E-Mail-Adressen (mailto:)
|
- Google Maps Integration für Adressen
|
||||||
- Adressen (Google Maps)
|
- Share-Funktion für Suchergebnisse
|
||||||
- Kundennummern (KKBefe-System)
|
- Trefferzähler
|
||||||
- Teilen-Funktion für einzelne Suchergebnisse
|
- Reset-Funktion für alle Suchfelder
|
||||||
- Responsive Design mit Bootstrap
|
|
||||||
- Docker-Container-Unterstützung
|
|
||||||
|
|
||||||
## Technische Details
|
|
||||||
|
|
||||||
### Technologie-Stack
|
|
||||||
|
|
||||||
- **Backend**: Python 3.11 mit Flask
|
|
||||||
- **Frontend**: HTML, CSS, JavaScript, Bootstrap 5
|
|
||||||
- **Datenverarbeitung**: pandas, numpy
|
|
||||||
- **Container**: Docker
|
|
||||||
|
|
||||||
### Projektstruktur
|
|
||||||
|
|
||||||
```
|
|
||||||
medi-customers/
|
|
||||||
├── app.py # Flask-Anwendung
|
|
||||||
├── templates/ # HTML-Templates
|
|
||||||
│ └── index.html # Hauptseite
|
|
||||||
├── spezexpo.csv # Kundendaten
|
|
||||||
├── requirements.txt # Python-Abhängigkeiten
|
|
||||||
├── Dockerfile # Docker-Konfiguration
|
|
||||||
├── docker-compose.yml # Docker Compose Konfiguration
|
|
||||||
└── .dockerignore # Docker-Ignore-Datei
|
|
||||||
```
|
|
||||||
|
|
||||||
### Datenformat
|
|
||||||
|
|
||||||
Die Anwendung erwartet eine CSV-Datei (`spezexpo.csv`) mit folgenden Spalten:
|
|
||||||
- Nummer (Kundennummer)
|
|
||||||
- Vorname
|
|
||||||
- Nachname
|
|
||||||
- Fachrichtung
|
|
||||||
- Strasse
|
|
||||||
- PLZ
|
|
||||||
- Ort
|
|
||||||
- Tel
|
|
||||||
- mail
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Lokale Entwicklung
|
1. Repository klonen:
|
||||||
|
|
||||||
1. Python 3.11 installieren
|
|
||||||
2. Virtuelle Umgebung erstellen und aktivieren:
|
|
||||||
```bash
|
```bash
|
||||||
python -m venv venv
|
git clone https://gitea.elpatron.me/elpatron/medi-customers.git
|
||||||
source venv/bin/activate # Linux/Mac
|
cd medi-customers
|
||||||
venv\Scripts\activate # Windows
|
|
||||||
```
|
```
|
||||||
3. Abhängigkeiten installieren:
|
|
||||||
|
2. Python-Abhängigkeiten installieren:
|
||||||
```bash
|
```bash
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
3. CSV-Datei in das `data`-Verzeichnis kopieren:
|
||||||
|
```bash
|
||||||
|
mkdir data
|
||||||
|
cp spezexpo.csv data/customers.csv
|
||||||
|
```
|
||||||
|
|
||||||
4. Anwendung starten:
|
4. Anwendung starten:
|
||||||
```bash
|
```bash
|
||||||
python app.py
|
python app.py
|
||||||
```
|
```
|
||||||
|
|
||||||
### Docker-Container
|
|
||||||
|
|
||||||
1. Docker installieren
|
|
||||||
2. Container mit Docker Compose starten:
|
|
||||||
```bash
|
|
||||||
docker-compose up --build
|
|
||||||
```
|
|
||||||
Die Anwendung ist dann unter `http://localhost:5001` erreichbar.
|
Die Anwendung ist dann unter `http://localhost:5001` erreichbar.
|
||||||
|
|
||||||
## API-Endpunkte
|
## API-Beispiele
|
||||||
|
|
||||||
### GET /
|
Die Such-API unterstützt folgende Parameter:
|
||||||
- Rendert die Hauptseite
|
|
||||||
|
|
||||||
### GET /search
|
### Spezifische Suche
|
||||||
- Sucht nach Kunden basierend auf verschiedenen Parametern
|
|
||||||
- Parameter:
|
|
||||||
- `name`: Suche nach Vor- oder Nachname
|
|
||||||
- `ort`: Suche nach Ort
|
|
||||||
- `kundennummer`: Suche nach Kundennummer
|
|
||||||
- `fachrichtung`: Suche nach Fachrichtung
|
|
||||||
- `q`: Allgemeine Suche über alle Felder
|
|
||||||
- Returns: JSON-Array mit gefundenen Kunden
|
|
||||||
|
|
||||||
#### API-Beispiele
|
|
||||||
|
|
||||||
1. Suche nach Namen:
|
|
||||||
```bash
|
```bash
|
||||||
|
# Nach Name suchen
|
||||||
curl "http://localhost:5001/search?name=Schmidt"
|
curl "http://localhost:5001/search?name=Schmidt"
|
||||||
```
|
|
||||||
|
|
||||||
2. Suche nach Ort:
|
# Nach Ort suchen
|
||||||
```bash
|
|
||||||
curl "http://localhost:5001/search?ort=Berlin"
|
curl "http://localhost:5001/search?ort=Berlin"
|
||||||
```
|
|
||||||
|
|
||||||
3. Suche nach Kundennummer:
|
# Nach Kundennummer suchen
|
||||||
```bash
|
|
||||||
curl "http://localhost:5001/search?kundennummer=12345"
|
curl "http://localhost:5001/search?kundennummer=12345"
|
||||||
```
|
|
||||||
|
|
||||||
4. Suche nach Fachrichtung:
|
# Nach Fachrichtung suchen
|
||||||
```bash
|
|
||||||
curl "http://localhost:5001/search?fachrichtung=Allgemeinmedizin"
|
curl "http://localhost:5001/search?fachrichtung=Allgemeinmedizin"
|
||||||
```
|
|
||||||
|
|
||||||
5. Kombinierte Suche:
|
# Nach Telefonnummer suchen
|
||||||
```bash
|
curl "http://localhost:5001/search?telefon=030"
|
||||||
|
|
||||||
|
# Kombinierte Suche
|
||||||
curl "http://localhost:5001/search?name=Schmidt&ort=Berlin&fachrichtung=Allgemeinmedizin"
|
curl "http://localhost:5001/search?name=Schmidt&ort=Berlin&fachrichtung=Allgemeinmedizin"
|
||||||
```
|
```
|
||||||
|
|
||||||
6. Allgemeine Suche:
|
### Allgemeine Suche
|
||||||
```bash
|
```bash
|
||||||
|
# Suche in allen Feldern
|
||||||
curl "http://localhost:5001/search?q=Schmidt"
|
curl "http://localhost:5001/search?q=Schmidt"
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Beispiel-Response
|
### Beispiel-Response
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Nummer": "12345",
|
|
||||||
"Vorname": "Max",
|
"Vorname": "Max",
|
||||||
"Nachname": "Schmidt",
|
"Nachname": "Mustermann",
|
||||||
"Fachrichtung": "Allgemeinmedizin",
|
"Nummer": "12345",
|
||||||
"Strasse": "Hauptstraße 1",
|
|
||||||
"PLZ": "10115",
|
|
||||||
"Ort": "Berlin",
|
"Ort": "Berlin",
|
||||||
"Tel": "030-123456",
|
"Fachrichtung": "Allgemeinmedizin",
|
||||||
"mail": "max.schmidt@example.com"
|
"Tel": "030123456",
|
||||||
|
"Email": "max@example.com"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Frontend-Funktionen
|
## Versionen
|
||||||
|
|
||||||
### Suchfunktion
|
### v1.0.1
|
||||||
- Live-Suche mit 300ms Debounce
|
- Telefonnummer-Suchfeld hinzugefügt
|
||||||
- Spezifische Suchfelder für präzise Suche
|
- Reset-Icons für alle Suchfelder
|
||||||
- Allgemeine Suche für breite Suche
|
- Verbesserte Positionierung der UI-Elemente
|
||||||
- Kombinierbare Suchkriterien
|
- Optimierte Suchlogik
|
||||||
- Trefferzähler für jedes Suchfeld
|
- CSV-Datei in data-Verzeichnis verschoben
|
||||||
|
|
||||||
### Link-Generierung
|
### v1.0.0
|
||||||
- `createPhoneLink()`: Erstellt tel:-Links mit führender 0
|
- Erste Version
|
||||||
- `createEmailLink()`: Erstellt mailto:-Links
|
- Grundlegende Suchfunktionalität
|
||||||
- `createAddressLink()`: Erstellt Google Maps-Links
|
- Klickbare Links für Telefon, E-Mail und Adressen
|
||||||
- `createCustomerLink()`: Erstellt KKBefe-System-Links
|
- Share-Funktion für Suchergebnisse
|
||||||
|
|
||||||
### Teilen-Funktion
|
|
||||||
- Individueller Teilen-Button für jedes Suchergebnis
|
|
||||||
- Kopiert einen direkten Link zum spezifischen Kunden
|
|
||||||
- Visuelles Feedback beim Kopieren
|
|
||||||
|
|
||||||
## Fehlerbehandlung
|
|
||||||
|
|
||||||
- Logging für Backend-Fehler
|
|
||||||
- Benutzerfreundliche Fehlermeldungen im Frontend
|
|
||||||
- Graceful Degradation bei fehlenden Daten
|
|
||||||
|
|
||||||
## Entwicklung
|
|
||||||
|
|
||||||
### Debug-Modus
|
|
||||||
Die Anwendung läuft standardmäßig im Debug-Modus:
|
|
||||||
```bash
|
|
||||||
python app.py
|
|
||||||
```
|
|
||||||
|
|
||||||
### Logging
|
|
||||||
- Backend-Logs werden mit Python's logging-Modul erstellt
|
|
||||||
- Log-Level: DEBUG
|
|
||||||
- Logs werden in der Konsole ausgegeben
|
|
||||||
|
|
||||||
## Wartung
|
|
||||||
|
|
||||||
### Container-Verwaltung
|
|
||||||
```bash
|
|
||||||
# Container stoppen
|
|
||||||
docker-compose down
|
|
||||||
|
|
||||||
# Container starten
|
|
||||||
docker-compose up
|
|
||||||
|
|
||||||
# Container im Hintergrund starten
|
|
||||||
docker-compose up -d
|
|
||||||
|
|
||||||
# Container-Logs anzeigen
|
|
||||||
docker-compose logs -f
|
|
||||||
```
|
|
||||||
|
|
||||||
### Datenaktualisierung
|
|
||||||
1. CSV-Datei aktualisieren
|
|
||||||
2. Container neu bauen und starten:
|
|
||||||
```bash
|
|
||||||
docker-compose down
|
|
||||||
docker-compose up --build
|
|
||||||
```
|
|
||||||
|
|
||||||
## Sicherheit
|
|
||||||
|
|
||||||
- Alle externen Links öffnen sich in neuen Tabs
|
|
||||||
- Sicherheitsattribute für externe Links (noopener, noreferrer)
|
|
||||||
- Input-Validierung im Backend
|
|
||||||
- Fehlerbehandlung für ungültige Daten
|
|
||||||
|
|
||||||
## Browser-Kompatibilität
|
|
||||||
|
|
||||||
Die Anwendung wurde getestet mit:
|
|
||||||
- Chrome (neueste Version)
|
|
||||||
- Firefox (neueste Version)
|
|
||||||
- Edge (neueste Version)
|
|
||||||
- Safari (neueste Version)
|
|
||||||
Reference in New Issue
Block a user