Initial commit
This commit is contained in:
@@ -0,0 +1,71 @@
|
||||
# Speech Learning App
|
||||
|
||||
Docker-basierter MVP fuer eine A1-Englisch-Lern-Web-App. Der Kern ist eine Go API, das Frontend ist React/TypeScript, FlowiseAI laeuft als eigener Container auf demselben VPS, und Azure Speech wird serverseitig gekapselt.
|
||||
|
||||
## Start auf dem VPS
|
||||
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
Danach:
|
||||
|
||||
- Web-App: https://speech.v2202510301049387828.goodsrv.de
|
||||
- API Healthcheck: https://speech.v2202510301049387828.goodsrv.de/api/health
|
||||
- Flowise: vorhandene Instanz ueber `FLOWISE_BASE_URL`
|
||||
|
||||
Der Default-Compose ist fuer den VPS portlos und haengt `speech-web`/`speech-api` an das bestehende Docker-Netzwerk `web`.
|
||||
|
||||
## Lokale Entwicklung
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
docker compose -f docker-compose.dev.yml up --build
|
||||
```
|
||||
|
||||
Danach:
|
||||
|
||||
- Web-App: http://localhost:5173
|
||||
- API Healthcheck: http://localhost:8080/health
|
||||
- Flowise: http://localhost:3000
|
||||
|
||||
Mit `AZURE_ENABLE_MOCK=true` laeuft die Aussprachebewertung ohne Azure Credentials. Fuer echte Azure Speech Calls `AZURE_SPEECH_KEY`, `AZURE_SPEECH_REGION` setzen und `AZURE_ENABLE_MOCK=false` verwenden.
|
||||
|
||||
## Debug
|
||||
|
||||
Debug ist ueber `.env` aktivierbar:
|
||||
|
||||
```env
|
||||
DEBUG_ENABLED=true
|
||||
LOG_LEVEL=debug
|
||||
```
|
||||
|
||||
Danach:
|
||||
|
||||
```bash
|
||||
docker compose up -d --force-recreate speech-api
|
||||
```
|
||||
|
||||
Eingeloggte Nutzer sehen dann in der Web-App den Navigationspunkt `Debug`. Die Ausgaben sind maskiert und zeigen keine Secrets.
|
||||
|
||||
## MVP-Funktionen
|
||||
|
||||
- Registrierung und Login
|
||||
- A1-Lernerprofil mit `en-US`
|
||||
- Dashboard mit Tagesziel und naechster Uebung
|
||||
- Browser-Audioaufnahme
|
||||
- Pronunciation Assessment API mit Azure/Mock-Fallback
|
||||
- Visuelles Wort-Feedback
|
||||
- Flowise-Adapter mit Mock-Fallback
|
||||
- Datenmodell vorbereitet fuer weitere Zielsprachen
|
||||
|
||||
## Architektur
|
||||
|
||||
```txt
|
||||
web -> api -> postgres
|
||||
-> redis
|
||||
-> flowise
|
||||
-> azure speech
|
||||
```
|
||||
|
||||
Der Browser spricht nur mit der Go API. Azure- und Flowise-Secrets bleiben im Backend.
|
||||
Reference in New Issue
Block a user