80 lines
2.2 KiB
Markdown
80 lines
2.2 KiB
Markdown
# 🦉 Crumbforest CRM & RAG System
|
|
|
|
**Multilingual CRM mit Role-Based Chat, RAG-Funktionalität und Tagebuch-System.**
|
|
|
|
## ✨ Features
|
|
|
|
### 🎭 Role System (Neu!)
|
|
- **8 Unique Characters**: DumboSQL, SnakePy, KungfuTaube, etc.
|
|
- **Role-Based Chat**: Dedizierte Chat-Interfaces für jede Rolle.
|
|
- **Syntax Highlighting**: Code-Blöcke werden automatisch hervorgehoben.
|
|
- **Mock Code Execution**: Simulierte Code-Ausführung für Python/PHP.
|
|
- **History Export**: Chat-Verläufe als JSON exportieren.
|
|
|
|
### 🎨 Theming & Accessibility
|
|
- **4 Themes**: Standard, Accessible, High Contrast, Admin Dark.
|
|
- **Settings Page**: User-spezifische Einstellungen für Schriftgröße und Animationen.
|
|
- **Group-Based Access**: Unterschiedliche Ansichten für Home, Demo und Admin.
|
|
|
|
### 🤖 RAG & Core
|
|
- **Document Auto-Indexing**: Markdown-Dateien werden automatisch indexiert.
|
|
- **Semantic Search**: Durchsuche Dokumentation via Embeddings.
|
|
- **Multi-Provider**: OpenAI, Anthropic Claude, OpenRouter.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
Das System läuft vollständig in Docker.
|
|
|
|
### 1. Starten
|
|
```bash
|
|
./start.sh
|
|
```
|
|
*Startet alle Container (App, DB, Qdrant).*
|
|
|
|
### 2. Setup (Einmalig)
|
|
```bash
|
|
python3 setup_demo_user.py
|
|
```
|
|
*Richtet den Demo-User mit korrekter Gruppe und Theme ein.*
|
|
|
|
### 3. Loslegen
|
|
Öffne **[http://localhost:8000](http://localhost:8000)**
|
|
|
|
**Login Credentials:**
|
|
- **User**: `demo@crumb.local`
|
|
- **Pass**: `demo123`
|
|
|
|
---
|
|
|
|
## 📂 Project Structure
|
|
|
|
- `crumbforest_config.json` - Zentrale Konfiguration für Rollen & Themes.
|
|
- `app/routers/crumbforest_roles.py` - Backend Logik für das Rollensystem.
|
|
- `app/templates/crumbforest/` - Frontend Templates (Dashboard, Chat).
|
|
- `docs/` - Dokumentation und RAG-Quellen.
|
|
|
|
## 🔧 Configuration
|
|
|
|
Die Konfiguration erfolgt über `.env` (Secrets) und `crumbforest_config.json` (Logik).
|
|
|
|
**Wichtige Env-Vars:**
|
|
```bash
|
|
OPENROUTER_API_KEY=sk-or-...
|
|
APP_SECRET=...
|
|
MARIADB_PASSWORD=...
|
|
```
|
|
|
|
## 📖 Dokumentation
|
|
|
|
- **[walkthrough.md](walkthrough.md)** - Detaillierte Tour durch das neue System.
|
|
- **[DATA_PRIVACY_LOCATION.md](DATA_PRIVACY_LOCATION.md)** - Datenschutz-Infos.
|
|
- **[QUICKSTART.md](QUICKSTART.md)** - (Legacy) RAG API Beispiele.
|
|
|
|
## 🦉 Happy Coding!
|
|
|
|
---
|
|
|
|
**Lizenz**: MIT License
|
|
**Kontakt**: CKL / Crumb B.
|
|
|