chore: Docs umstrukturiert, Client-Updates, Scripts nach scripts/
This commit is contained in:
95
STRUCTURE.md
Normal file
95
STRUCTURE.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# Projektstruktur-Übersicht
|
||||
|
||||
Diese Datei beschreibt die organisierte Struktur des Projekts.
|
||||
|
||||
## 📁 Hauptverzeichnisse
|
||||
|
||||
### `/client/`
|
||||
React Frontend-Anwendung
|
||||
- `src/` - Quellcode
|
||||
- `public/` - Statische Assets
|
||||
- `package.json` - Frontend-Dependencies
|
||||
|
||||
### `/server/`
|
||||
Node.js Backend-Server
|
||||
- `routes/` - API-Routen
|
||||
- `services/` - Business-Logik
|
||||
- `middleware/` - Express-Middleware
|
||||
- `config/` - Konfiguration
|
||||
- `utils/` - Utility-Funktionen
|
||||
- `package.json` - Backend-Dependencies
|
||||
|
||||
### `/docs/`
|
||||
Alle Dokumentation
|
||||
- `setup/` - Setup-Anleitungen (Appwrite, OAuth, etc.)
|
||||
- `deployment/` - Deployment & Production-Docs
|
||||
- `development/` - Development-Dokumentation
|
||||
- `server/` - Server-spezifische Dokumentation
|
||||
- `examples/` - Beispiel-Code (z.B. starter-for-react)
|
||||
- `legacy/` - Legacy-Dateien
|
||||
|
||||
### `/scripts/`
|
||||
Hilfs-Scripts für Entwicklung & Deployment
|
||||
- Git-Scripts (`git-commit.*`, `run-git-commit.ps1`)
|
||||
- Deployment-Scripts (`deploy-build.js`)
|
||||
- Setup-Scripts (`setup-appwrite.ps1`, `setup-production.ps1`)
|
||||
- Commit-Hilfsdateien (`COMMIT_MESSAGE.md`, `COMMIT_COMMANDS.txt`)
|
||||
|
||||
### `/marketing/`
|
||||
Marketing-Materialien und Dokumentation
|
||||
- Logo-Dateien (SVG)
|
||||
- Marketing-Guides (TikTok, YouTube, Product Hunt, etc.)
|
||||
- Influencer-Templates
|
||||
|
||||
### `/n8n/`
|
||||
n8n Workflow-Konfigurationen
|
||||
- `workflows/` - Workflow-Definitionen
|
||||
|
||||
### `/.kiro/`
|
||||
Kiro-Spezifikationen (Design, Requirements, Tasks)
|
||||
|
||||
## 📄 Root-Dateien
|
||||
|
||||
- `README.md` - Haupt-README mit Projektübersicht
|
||||
- `STRUCTURE.md` - Diese Datei
|
||||
- `.env.example` - Beispiel-Umgebungsvariablen
|
||||
- `.gitignore` - Git-Ignore-Regeln
|
||||
|
||||
## 🎯 Organisationsprinzipien
|
||||
|
||||
1. **Dokumentation zentralisiert:** Alle `.md` Dateien sind in `docs/` organisiert
|
||||
2. **Scripts getrennt:** Alle Scripts sind in `scripts/` gesammelt
|
||||
3. **Sauberes Root:** Root-Verzeichnis enthält nur essenzielle Dateien
|
||||
4. **Klare Kategorien:** Dokumentation nach Themen sortiert (setup, deployment, development)
|
||||
|
||||
## 📝 Wichtige Dateien
|
||||
|
||||
### Setup
|
||||
- `docs/setup/SETUP_GUIDE.md` - Allgemeine Setup-Anleitung
|
||||
- `docs/setup/APPWRITE_SETUP.md` - Appwrite-Konfiguration
|
||||
- `docs/setup/GOOGLE_OAUTH_SETUP.md` - Google OAuth Setup
|
||||
|
||||
### Deployment
|
||||
- `docs/deployment/PRODUCTION_SETUP.md` - Production-Server Setup
|
||||
- `docs/deployment/DEPLOYMENT_INSTRUCTIONS.md` - Deployment-Anleitung
|
||||
|
||||
### Development
|
||||
- `docs/development/PROJECT_REVIEW_SUMMARY.md` - Projekt-Review
|
||||
- `docs/development/TESTING_SUMMARY.md` - Testing-Dokumentation
|
||||
|
||||
## 🔧 Scripts-Verwendung
|
||||
|
||||
Alle Scripts befinden sich in `scripts/`:
|
||||
|
||||
```bash
|
||||
# Git-Commit (Windows)
|
||||
scripts\git-commit.bat
|
||||
|
||||
# Git-Commit (PowerShell)
|
||||
scripts\run-git-commit.ps1
|
||||
|
||||
# Deployment
|
||||
node scripts\deploy-build.js
|
||||
```
|
||||
|
||||
Siehe `scripts/README.md` für Details.
|
||||
Reference in New Issue
Block a user