143 lines
4.4 KiB
Markdown
143 lines
4.4 KiB
Markdown
# 📁 Projekt-Ordnung und Dateistruktur
|
|
|
|
Diese Datei beschreibt die Organisation aller Dateien im Projekt.
|
|
|
|
## ✅ Wichtige Dateien (behalten)
|
|
|
|
### Root-Verzeichnis
|
|
|
|
- **README.md** - Hauptdokumentation des Projekts
|
|
- **STRUCTURE.md** - Detaillierte Projektstruktur
|
|
- **.gitignore** - Git-Ignore-Regeln
|
|
- **.env.example** - Beispiel-Umgebungsvariablen
|
|
|
|
### Client (`client/`)
|
|
|
|
- Alle Source-Dateien in `src/`
|
|
- Konfigurationsdateien (`package.json`, `vite.config.ts`, etc.)
|
|
- **README.md** - Client-spezifische Dokumentation
|
|
|
|
### Server (`server/`)
|
|
|
|
- Alle Backend-Dateien
|
|
- **routes/** - API-Routen (inkl. `webhook.mjs` für automatisches Deployment)
|
|
- **config/** - Konfiguration
|
|
- **.env** - Umgebungsvariablen (nicht im Git!)
|
|
|
|
### Dokumentation (`docs/`)
|
|
|
|
- **deployment/** - Deployment-Anleitungen
|
|
- `GITEA_WEBHOOK_SETUP.md` - Vollständige Webhook-Anleitung
|
|
- `WEBHOOK_QUICK_START.md` - Schnellstart
|
|
- `WEBHOOK_AUTHORIZATION.md` - Authentifizierung
|
|
- `DEPLOYMENT_INSTRUCTIONS.md` - Manuelles Deployment
|
|
- `PRODUCTION_SETUP.md` - Production-Setup
|
|
- `PRODUCTION_FIXES.md` - Bekannte Probleme
|
|
- **setup/** - Setup-Anleitungen
|
|
- **development/** - Development-Dokumentation
|
|
- **server/** - Server-Dokumentation
|
|
|
|
### Scripts (`scripts/`)
|
|
|
|
- **deploy-to-server.mjs** - Deployment-Skript (wird vom Webhook aufgerufen)
|
|
- **setup-*.ps1** - Setup-Scripts
|
|
- **README.md** - Scripts-Dokumentation
|
|
|
|
### Marketing (`marketing/`)
|
|
|
|
- Alle Marketing-Materialien und Anleitungen
|
|
|
|
## 🗑️ Kann entfernt werden (temporäre/veraltete Dateien)
|
|
|
|
### Scripts (`scripts/`)
|
|
|
|
Diese Git-Commit-Scripts sind veraltet und können entfernt werden:
|
|
|
|
- `git-commit.bat`
|
|
- `git-commit.sh`
|
|
- `git-commit-fix.bat`
|
|
- `FINAL_COMMIT.bat`
|
|
- `run-git-commit.ps1`
|
|
- `COMMIT_COMMANDS.txt`
|
|
- `COMMIT_MESSAGE.md`
|
|
|
|
**Grund:** Git-Commits sollten direkt über `git commit` gemacht werden.
|
|
|
|
### Dokumentation (`docs/`)
|
|
|
|
Einige temporäre/veraltete Dokumentationsdateien können archiviert werden:
|
|
|
|
- `development/TASK_5_COMPLETION.md` - Task-spezifisch, kann archiviert werden
|
|
- `server/TASK_4_COMPLETION_SUMMARY.md` - Task-spezifisch, kann archiviert werden
|
|
- `development/PROJECT_REVIEW_SUMMARY.md` - Review-spezifisch, kann archiviert werden
|
|
|
|
**Empfehlung:** Verschiebe diese in `docs/archive/` statt zu löschen.
|
|
|
|
## 📋 Dateien-Organisation
|
|
|
|
### Aktuelle Struktur
|
|
|
|
```
|
|
/
|
|
├── client/ # Frontend
|
|
├── server/ # Backend
|
|
├── docs/ # Dokumentation
|
|
│ ├── deployment/ # Deployment-Docs ✅
|
|
│ ├── setup/ # Setup-Docs ✅
|
|
│ ├── development/ # Development-Docs (teilweise archivieren)
|
|
│ └── server/ # Server-Docs (teilweise archivieren)
|
|
├── scripts/ # Scripts
|
|
│ ├── deploy-to-server.mjs ✅
|
|
│ ├── setup-*.ps1 ✅
|
|
│ └── [veraltete Git-Scripts] ❌
|
|
├── marketing/ # Marketing ✅
|
|
└── README.md # Hauptdokumentation ✅
|
|
```
|
|
|
|
## 🧹 Aufräumen-Empfehlungen
|
|
|
|
### 1. Veraltete Scripts entfernen
|
|
|
|
```bash
|
|
# Diese Dateien können gelöscht werden:
|
|
scripts/git-commit.bat
|
|
scripts/git-commit.sh
|
|
scripts/git-commit-fix.bat
|
|
scripts/FINAL_COMMIT.bat
|
|
scripts/run-git-commit.ps1
|
|
scripts/COMMIT_COMMANDS.txt
|
|
scripts/COMMIT_MESSAGE.md
|
|
```
|
|
|
|
### 2. Temporäre Dokumentation archivieren
|
|
|
|
Erstelle `docs/archive/` und verschiebe:
|
|
- `docs/development/TASK_5_COMPLETION.md`
|
|
- `docs/server/TASK_4_COMPLETION_SUMMARY.md`
|
|
- `docs/development/PROJECT_REVIEW_SUMMARY.md`
|
|
|
|
### 3. README aktualisieren
|
|
|
|
Die `scripts/README.md` wurde bereits aktualisiert.
|
|
|
|
## ✅ Checkliste
|
|
|
|
- [x] Webhook-Dokumentation in `docs/deployment/` organisiert
|
|
- [x] Scripts-README aktualisiert
|
|
- [x] Deployment-Dokumentation strukturiert
|
|
- [ ] Veraltete Scripts entfernen (optional)
|
|
- [ ] Temporäre Dokumentation archivieren (optional)
|
|
|
|
## 📝 Wichtige Hinweise
|
|
|
|
1. **`.env` Dateien** sind nie im Git (siehe `.gitignore`)
|
|
2. **Temporäre Anleitungen** können nach erfolgreicher Einrichtung entfernt werden
|
|
3. **Task-spezifische Dokumentation** kann archiviert werden, sollte aber nicht gelöscht werden
|
|
4. **Alle produktiven Dateien** (Code, Konfiguration, aktive Dokumentation) bleiben erhalten
|
|
|
|
## 🔄 Regelmäßige Wartung
|
|
|
|
- **Monatlich:** Prüfe auf veraltete Scripts/Dokumentation
|
|
- **Nach großen Features:** Aktualisiere README und Dokumentation
|
|
- **Nach Deployment:** Entferne temporäre Deployment-Anleitungen (falls nicht mehr benötigt)
|