quote-system/QUICKSTART.md

161 lines
4.0 KiB
Markdown

# Schnellstart-Anleitung
## Installation in 3 Schritten
### Schritt 1: Voraussetzungen prüfen
- Docker Desktop installiert und gestartet
- Port 3000 ist verfügbar
### Schritt 2: Anwendung starten
**Linux/Mac:**
```bash
./start.sh
```
**Windows:**
Doppelklick auf `start.bat`
**Manuell mit Docker Compose:**
```bash
docker-compose up -d
```
### Schritt 3: Anwendung öffnen
Öffnen Sie im Browser: http://localhost:3000
## Erste Schritte in der Anwendung
### 1. Kunden anlegen
- Klicken Sie auf "Customers" in der Navigation
- Klicken Sie auf "+ New Customer"
- Füllen Sie die Formulardaten aus:
- Company Name: z.B. "ABC Corporation"
- Street Address: z.B. "123 Main Street"
- City: z.B. "Corpus Christi"
- State: z.B. "TX"
- Zip Code: z.B. "78401"
- Account Number: Optional, z.B. "ACC-12345"
- Klicken Sie auf "Save Customer"
### 2. Erstes Quote erstellen
- Klicken Sie auf "Quotes" in der Navigation
- Klicken Sie auf "+ New Quote"
- Wählen Sie einen Kunden aus dem Dropdown
- Die Quote-Nummer wird automatisch generiert (z.B. 2026-01-0001)
- Das Datum ist vorausgefüllt, kann aber geändert werden
- Klicken Sie auf "+ Add Item" um Positionen hinzuzufügen:
- Quantity: z.B. "1" oder "2" oder "TBD"
- Description: Beschreibung des Produkts/Service
- Rate: Preis pro Einheit, z.B. "100.00" oder "150.00/hr"
- Amount: Gesamtbetrag, z.B. "100.00"
- TBD: Setzen Sie das Häkchen für "To Be Determined" Items
- Bei Tax-Exempt Kunden (Churches, Non-Profits):
- Aktivieren Sie "Tax Exempt"
- Bei TBD Items:
- Geben Sie eine Fußnote ein, z.B. "Total excludes labor charges..."
- Klicken Sie auf "Save Quote"
### 3. PDF generieren
- In der Quote-Liste klicken Sie auf "PDF" beim gewünschten Quote
- Das PDF wird automatisch heruntergeladen
## Beispiel-Workflow
1. **Kunde "Braselton Development" ist bereits angelegt** (aus init.sql)
2. **Neues Quote erstellen:**
- Customer: Braselton Development
- Quote #: 2026-01-0001 (automatisch)
- Date: Heute (automatisch)
- Item 1:
- Qty: 1
- Description: Lenovo Yoga Laptop Setup
- Rate: 2,890.00
- Amount: 2,890.00
- Item 2:
- Qty: TBD
- Description: Labor for installation
- Rate: 125.00/hr
- Amount: TBD (Checkbox aktivieren)
- TBD Note: "Labor charges will be determined based on actual time"
- Tax: 8.25% (automatisch berechnet, außer Tax Exempt ist aktiviert)
3. **Quote speichern**
4. **PDF herunterladen** → Professionelles Dokument im Corporate Design
## Nützliche Befehle
### Logs ansehen
```bash
docker-compose logs -f
```
### Anwendung stoppen
```bash
docker-compose down
```
### Anwendung neu starten
```bash
docker-compose restart
```
### Datenbank-Backup erstellen
```bash
docker exec quote_postgres pg_dump -U quoteuser quotedb > backup_$(date +%Y%m%d).sql
```
## Tipps & Tricks
1. **Quote-Nummern:** Werden automatisch monatlich hochgezählt
- Januar 2026: 2026-01-0001, 2026-01-0002, ...
- Februar 2026: 2026-02-0001, 2026-02-0002, ...
2. **TBD Items:** Ideal für:
- Stundenbasierte Arbeit
- Noch nicht feststehende Mengen
- Variable Kosten
3. **Tax Exempt:** Verwenden Sie diese Option für:
- Kirchen (Churches)
- Non-Profit Organisationen
- Gemeinnützige Vereine
4. **Bearbeitung:** Alle Quotes können nachträglich bearbeitet werden
- Klicken Sie einfach auf "Edit"
- Ändern Sie die Daten
- Speichern Sie erneut
5. **PDF-Qualität:** Die PDFs entsprechen exakt Ihrer HTML-Vorlage
- Professionelles Layout
- Druckfertig
- Letterformat (8.5" x 11")
## Fehlerbehebung
### Port 3000 bereits belegt?
Ändern Sie in `docker-compose.yml`:
```yaml
ports:
- "3001:3000" # Statt 3000:3000
```
Dann öffnen Sie: http://localhost:3001
### Datenbank-Fehler?
```bash
docker-compose down -v # VORSICHT: Löscht alle Daten!
docker-compose up -d
```
### Anwendung lädt nicht?
```bash
# Prüfen Sie die Logs
docker-compose logs app
# Prüfen Sie ob Container laufen
docker ps
```
## Support
Bei weiteren Fragen schauen Sie in die ausführliche README.md Datei.