Files
waldseilgarten-crm/README.md
Henry 50e9e0cbc7 Add Revamp Review after code analysis
- Analyzed existing codebase on waldseilgarten server
- Found: NestJS backend with Auth, Customers, Documents
- Found: React frontend with all major pages
- Status: Partially functional, needs stabilization
- Created comprehensive Revamp Review with:
  - Hexagonal Architecture proposal
  - Security improvements
  - Testing strategy
  - Incremental revamp plan (4 weeks)
  - Action items prioritized
2026-03-14 14:35:17 +00:00

143 lines
3.4 KiB
Markdown

# Waldseilgarten Herrenberg CRM
**Ein modernes CRM- und Projektmanagementsystem für den Waldseilgarten Herrenberg**
---
## 🎯 Projekt-Übersicht
Das Waldseilgarten CRM ist eine maßgeschneiderte Lösung für das Kunden- und Projektanagement des Waldseilgarten Herrenberg. **Status: Teilweise funktional, Revamp empfohlen.**
### Aktueller Status
| Komponente | Status | Details |
|------------|--------|---------|
| 🔐 Backend (NestJS) | 🟡 Teilweise | Auth, Customers, Documents existieren |
| 🎨 Frontend (React) | 🟡 Teilweise | Alle Pages vorhanden, Integration unklar |
| 📊 API-Doku | 🟢 Vorhanden | Swagger unter `/api/docs` |
| 🧪 Tests | 🔴 Fehlen | Keine automatisierten Tests |
| 🚀 Deployment | 🟡 Container existieren | Nicht gestartet (Created state) |
### Empfohlener Next Step: Revamp
Siehe [AI Council Review - Revamp](docs/AI_COUNCIL_REVIEW_REVAMP.md)
---
## 🏗️ Tech Stack
### Backend
- **Framework:** NestJS (Node.js)
- **Datenbank:** PostgreSQL 18
- **Cache:** Redis 7
- **ORM:** TypeORM
- **Auth:** Passport + JWT
### Frontend
- **Framework:** React 19 + TypeScript
- **Build:** Vite
- **UI:** shadcn/ui + Tailwind CSS
- **State:** Zustand
- **Queries:** TanStack Query
### DevOps
- **Container:** Podman
- **Orchestrierung:** podman-compose
- **Reverse Proxy:** Traefik
- **SSL:** Let's Encrypt
---
## 📁 Projektstruktur
```
waldseilgarten-herrenberg-crm/
├── docs/
│ ├── TDD.md # Technical Design Document
│ ├── AI_COUNCIL_REVIEW.md # Architektur-Review
│ ├── USER_STORIES.md # Anforderungen
│ └── ARCHITECTURE.md # Systemarchitektur
├── src/ # Source Code (wird vom Server gespiegelt)
├── tests/ # Test-Suite
├── config/ # Konfigurationsdateien
└── README.md # Diese Datei
```
---
## 🚀 Schnellstart
### Voraussetzungen
- Podman installiert
- Zugriff auf Server: `waldseilgarten` (85.199.86.188)
### Deployment
```bash
# Auf dem Server (waldseilgarten)
ssh b0rbor4d@85.199.86.188
cd ~/projects/waldseilgarten-crm
# Container starten
podman-compose up -d
# Status prüfen
podman ps
```
### URLs
| Service | URL |
|---------|-----|
| Frontend | https://crm.waldseilgarten-herrenberg.de |
| API | https://api.waldseilgarten-herrenberg.de |
| Traefik | https://traefik.waldseilgarten-herrenberg.de |
---
## 📋 Dokumentation
- **[TDD](docs/TDD.md)** - Technisches Design-Dokument
- **[AI Council Review](docs/AI_COUNCIL_REVIEW.md)** - Kritisches Architektur-Review
- **[User Stories](docs/USER_STORIES.md)** - Detaillierte Anforderungen
- **[Architektur](docs/ARCHITECTURE.md)** - Systemarchitektur & Datenfluss
---
## 🗓️ Roadmap
### Phase 1: Foundation (Woche 1-3)
- ✅ User Auth
- ✅ Kundenverwaltung
- ✅ Projektmanagement
- ✅ Dashboard
### Phase 2: Dokumente (Woche 4)
- 🔄 Upload & Download
- 🔄 Lokale Speicherung
### Phase 3: Aufgaben (Woche 5)
- ⏳ Task-Management
- ⏳ Kanban-Board
### Phase 4: E-Mail (Woche 6-7)
- ⏳ IMAP-Integration
- ⏳ E-Mail-Zuordnung
### Phase 5: Erweiterungen (Woche 8-11)
- ⏳ Google Calendar
- ⏳ SeaDrive Sync
- ⏳ Reporting
---
## 👥 Kontakt
**Entwicklung:** Insight-IT GmbH
**Kunde:** Waldseilgarten Herrenberg
**Stand:** März 2026
---
## 📜 Lizenz
MIT © 2026 Florian Hartmann / Waldseilgarten Herrenberg