This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Installation und Start

Voraussetzungen

• Node.js ab Version 22 (empfohlen 24 LTS, wie im Docker-Image)
• Für die Texterkennung: Windows (bringt sie mit) oder unter Linux pdftotext, pdftoppm (poppler) und tesseract mit deutschen Sprachdaten – im Docker-Image ist das schon drin. Ohne wird nur nach Dateinamen zugeordnet.
• Für den Betrieb auf einem Server: Docker – siehe Server und Instanzen

Lokal starten

cd <projektordner>
npm install      # einmalig
npm start

Danach im Browser: http://localhost:4711. Bequemer: Doppelklick auf start.cmd.

Lokal hört der Server nur auf 127.0.0.1 – von anderen Rechnern ist er nicht erreichbar.

Wo liegen die Daten?

Was	Wo
Dokumente	%USERPROFILE%\Dropbox\Immobilien (die Dropbox wird über ihre info.json automatisch gefunden)
Stammdaten	data\daten.json im Projektordner
Gelöschte Dokumente	…\Immobilien\_Papierkorb\<Datum>\…
Schlüssel für gespeicherte Passwörter	IMMO_KEY oder .cache\secret.key
Zwischenspeicher der Texterkennung	.cache\texterkennung (Text je Dateiinhalt, index.json)

data\daten.json enthält echte Zahlen und wird nicht versioniert.

Umgebungsvariablen

Variable	Wirkung	Vorgabe
IMMO_BASIS	Ablageordner der Dokumente	<Dropbox>\Immobilien
IMMO_DATEN	Datendatei	data\daten.json
IMMO_ALT	Quellordner für das Einsortieren des Altbestands	Ordner in der Dropbox
IMMO_KEY	Schlüssel für verschlüsselte Geheimnisse (SMTP-Passwort, Client-Secrets)	wird in .cache\secret.key erzeugt
IMMO_OCR_SEITEN	Seiten je Scan für die Texterkennung	10
IMMO_VOLLTEXT	Volltext-Lauf von selbst (an) oder nur auf Knopfdruck (aus)	im Container an, sonst aus
IMMO_OCR_CACHE	Ordner des Zwischenspeichers der Texterkennung	.cache\texterkennung
PORT	Port des Servers	4711
HOST	Schnittstelle	127.0.0.1 (im Container 0.0.0.0)

Zum Ausprobieren: Demodaten

npm run demo        # erzeugt .demo\ mit erfundenen Objekten und einer Beispielablage
npm run demo:start  # startet den Server damit auf Port 4799

Die Screenshots in README und Wiki stammen aus diesem Datensatz.

Alle npm-Befehle

Befehl	Zweck
npm start	Server starten
npm run demo / demo:start	Demodaten erzeugen / damit starten
npm run vorschlag	Altbestand: Zuordnungsliste erzeugen, nichts wird geschrieben
npm run einsortieren	Altbestand: Dateien kopieren
npm run hinweise	Hinweis-Mails prüfen und ggf. verschicken
npm run hinweise:test	Testmail verschicken
npm run hinweise:vorschau	anzeigen, was gemeldet würde
npm test	alle Tests

Weiter: Objekt anlegen