Files
MindSift/Doku/README.md
T
sandrodachandClaude Opus 5.5 4e39b367bd
MindSift CI & Docker Release / Build, Test in Container & Push (push) Successful in 1m30s
release: v0.2 – collaboration docs, richer demo data, new screenshots
- Turn the collaboration plan into module docs (Doku/modules/collaboration.md)
  describing the implemented state; remove Doku/plans
- Header version comes from the build: git tag via APP_VERSION (CI passes
  it for tag builds), otherwise "<package version>-dev"; package 0.2.0
- Sample data (setup option and demo mode): six inbox thoughts, two task
  lists with Kanban states, subtasks and due dates, shopping and packing
  lists, three notes in folders incl. a long nested outline; demo mode
  shares the note and two lists with user/user
- e2e/screenshots.sh renews the README screenshots from demo data
- README: live collaboration, editor sharing, image tags, version badge

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-28 15:32:31 +01:00

2.6 KiB

MindSift Technische Dokumentation

Referenz für Entwickler und Administratoren. Alle Angaben wurden gegen den Code im Branch dev geprüft (Stand Oktober 2026). Abweichungen zwischen Doku und Code melde bitte als Fehler in flaws.md.

Inhalt

Dokument Inhalt
architecture.md Aufbau, Technologie-Stack, Start, Konfiguration, Build
database.md SQLite-Schema, Migrationen, Datenmodell
api/rest.md Alle REST-Endpunkte
api/websocket.md Echtzeit über WebSocket und SSE, Ereignisse
modules/triage.md Schnellerfassung und Triage
modules/tasks.md Aufgaben, Kanban, Alarme
modules/workspace.md Outliner-Notizen, Ordner, Tags
modules/collaboration.md Gemeinsames Bearbeiten von Notizen: Log, Sperren, Konflikte, Offline, Transport-Stufen
modules/lists.md Geteilte Listen
sharing-and-permissions.md Rollen, Gruppen, Freigaben
reverse-proxy.md Nginx, Traefik, Caddy, Cloudflare
theming.md Themes und Design-Variablen
flaws.md Bekannte Schwachstellen und technische Schulden

Überblick in 60 Sekunden

  • Ein Go-Binary liefert REST-API, WebSocket/SSE und das eingebettete React-Frontend (go:embed). Es gibt genau einen Container und eine SQLite-Datei (/data/mindsift.db).
  • Datenhaltung: vollständig in SQLite. Es gibt keine .md-Dateien auf der Platte; Markdown wird bei Bedarf aus den Blöcken erzeugt (documents.markdown_cache, Export als .md).
  • Echtzeit: ein Hub mit Räumen und Benutzer-Kanälen (WebSocket, SSE als Ersatz). Verteilt werden Ereignisse nach Änderungen.
  • Notizen gemeinsam bearbeiten: server-autoritatives Operations-Log mit Versionen und Sperren pro Bullet, Konfliktkopien statt Überschreiben, Offline-Warteschlange in IndexedDB, Abgleich auch hinter restriktiven Proxys (modules/collaboration.md).
  • Auth: JWT (HS256, 30 Tage) mit token_version und Sperrliste, dazu API-Keys (mindsift_sec_…) für Webhooks.
  • Freigaben: Aufgabenlisten, geteilte Listen, Notizen und Ordner jeweils mit Rolle Bearbeiter oder Leser.

Entwickeln

# Backend (Go 1.23)
go vet ./... && go test ./...

# Frontend (Node 22)
cd frontend && npm ci && npx tsc --noEmit && npm run test:run && npm run build

Das Frontend wird für das Binary nach cmd/server/dist gebaut (siehe Dockerfile). Die CI läuft unter .gitea/workflows/build-and-publish.yaml.