pointcab_webexport/README.md

102 lines
3.3 KiB
Markdown

# PointCab Webexport Server
Ein webbasiertes System zum Teilen und Anzeigen von PointCab Webexport-Projekten (360°-Panoramen, 3D-Modelle).
## 🎯 Features
- **Projekt-Upload:** ZIP/RAR-Archive hochladen und automatisch entpacken
- **Manuelle Projekte:** Leere Projekte erstellen und später befüllen
- **Multi-HTML-Unterstützung:** Automatische Erkennung und Auswahl bei mehreren HTML-Dateien
- **Passwort-Schutz:** Optionaler Passwort-Schutz für Projekte
- **Ablaufdatum:** Projekte können ein Ablaufdatum haben
- **Share-Links:** Eindeutige Share-Links für jedes Projekt
- **Admin-Dashboard:** Verwaltung aller Projekte
- **RAR-Entpacken:** Server-seitiges Entpacken von RAR-Archiven
## 🛠️ Technologie-Stack
| Komponente | Technologie |
|------------|-------------|
| Backend | NestJS (TypeScript) |
| Datenbank | PostgreSQL |
| ORM | Prisma |
| Process Manager | PM2 |
| Reverse Proxy | Nginx Proxy Manager |
| OS | Ubuntu 24.04 LTS |
## 🚀 Quick Start
### Voraussetzungen
- Ubuntu 24.04 LTS Server
- Root-Zugang
- Domain (optional, aber empfohlen)
### Installation
```bash
# Repository klonen
git clone https://your-gitea-server/pointcab-webexport.git
cd pointcab-webexport
# Installation starten
chmod +x scripts/install.sh
sudo ./scripts/install.sh
```
Detaillierte Anleitung: [INSTALLATION.md](INSTALLATION.md)
## 📖 Dokumentation
| Dokument | Beschreibung |
|----------|--------------|
| [INSTALLATION.md](INSTALLATION.md) | Komplette Installationsanleitung |
| [DEPLOYMENT.md](DEPLOYMENT.md) | Deployment-Prozess |
| [USER_GUIDE.md](USER_GUIDE.md) | Benutzerhandbuch |
| [MAINTENANCE.md](MAINTENANCE.md) | Wartung und Bereinigung |
| [GITEA_WORKFLOW.md](GITEA_WORKFLOW.md) | Git-Workflow Best Practices |
| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | System-Architektur |
| [docs/CHANGELOG.md](docs/CHANGELOG.md) | Änderungshistorie |
## 📂 Projektstruktur
```
pointcab_webexport_git/
├── README.md # Diese Datei
├── LICENSE # MIT Lizenz
├── INSTALLATION.md # Installationsanleitung
├── DEPLOYMENT.md # Deployment-Dokumentation
├── USER_GUIDE.md # Benutzerhandbuch
├── MAINTENANCE.md # Wartungsanleitung
├── GITEA_WORKFLOW.md # Git-Workflow
├── .gitignore # Git-Ignorierung
├── nodejs_space/ # Server-Code
│ ├── src/
│ │ ├── controllers/ # HTTP-Controller
│ │ └── services/ # Business-Logik
│ ├── prisma/
│ │ └── schema.prisma # Datenbank-Schema
│ ├── package.json
│ └── tsconfig.json
├── scripts/ # Hilfsskripte
│ ├── install.sh # Installation
│ ├── deploy.sh # Deployment
│ ├── cleanup.sh # Bereinigung
│ └── db-check.sh # DB-Prüfung
└── docs/
├── ARCHITECTURE.md # Architektur
└── CHANGELOG.md # Änderungshistorie
```
## 🔗 Links
- **Live-Demo:** https://pointcab-webexport.zell-cloud.de
- **Admin-Dashboard:** https://pointcab-webexport.zell-cloud.de/admin/dashboard
## 📄 Lizenz
Dieses Projekt ist unter der [MIT Lizenz](LICENSE) lizenziert.
## 👤 Autor
Entwickelt für die PointCab Webexport-Infrastruktur.