Initial commit: Waldseilgarten CRM Project Documentation
- README with project overview - TDD (Technical Design Document) - AI Council Review with critical analysis - User Stories (27 stories, 120 SP) - Architecture documentation Stack: NestJS + React + PostgreSQL + Redis Server: waldseilgarten (85.199.86.188)
This commit is contained in:
140
README.md
Normal file
140
README.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# 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. Es vereint CRM-Funktionalitäten mit Projektmanagement, Dokumentenverwaltung und E-Mail-Integration.
|
||||
|
||||
### Kernfunktionen
|
||||
|
||||
| Modul | Status | Beschreibung |
|
||||
|-------|--------|--------------|
|
||||
| 🔐 Authentifizierung | ✅ Geplant | JWT-basierte Auth mit Rollen |
|
||||
| 👥 Kundenverwaltung | ✅ Geplant | Firmen, Ansprechpartner, Historie |
|
||||
| 📁 Projektmanagement | ✅ Geplant | Projekte, Aufgaben, Meilensteine |
|
||||
| 📄 Dokumentenverwaltung | ✅ Geplant | Upload, Versionierung, SeaDrive |
|
||||
| 📧 E-Mail-Integration | ✅ Geplant | IMAP-Sync, Zuordnung |
|
||||
| 📅 Kalender-Integration | ✅ Geplant | Google Calendar Sync |
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ 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
|
||||
Reference in New Issue
Block a user