Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chatpott

Chatpott ist ein KI-Chat-Assistent für Bürgerinnen und Bürger einer Stadt. Er beantwortet Fragen zu städtischen Dienstleistungen, Orten, Veranstaltungen und Abfuhrterminen und nennt dazu Quellen. Grundlage ist eine Wissensdatenbank, die die Verwaltung selbst pflegt.

Entwickelt von GeoMesh im Projekt „KI-Chatbot für Bürger“ des Co-Creation-Funds der Smart City Oberhausen. Im Betrieb unter chatpott.de.

Lizenz: AGPL-3.0-only, siehe LICENSING.md und THIRD-PARTY-NOTICES.md.

Funktionen

  • Chat mit gestreamten Antworten, Quellenangaben, Karten und Infokarten
  • Wissensdatenbank (Markdown/Text) mit Stichwort- und Vektorsuche
  • Werkzeuge für Veranstaltungen und Abfuhrtermine
  • Verwaltung für Inhalte, System-Prompt, Modell, Werkzeuge, Benutzer und Statistiken
  • Anonyme Nutzung oder Konten mit Rollen
  • Deutsch und Englisch, einstellbare Schriftgröße, Lesehilfe-Schrift, Dark Mode

Komponenten

Teil Technik Ort
Frontend React 19, TypeScript, Vite, TanStack Router, Tailwind CSS src/
Backend Convex (Datenbank, Funktionen, Such- und Vektorindex, Auth) convex/
KI Vercel AI SDK, Modelle über OpenRouter convex/agent/, convex/tools/

Details: Architektur, Betrieb, Benutzerhandbuch, Spezifikation. Fremdkomponenten mit Lizenzen: SPDX_chatpott.spdx.json.

Schnellstart

Voraussetzungen: Bun, ein Convex-Konto, ein OpenRouter-API-Schlüssel.

bun install
bun run dev:backend              # Convex-Deployment anlegen, läuft weiter
bun scripts/setup_convex_env.ts  # Ausgabe als Convex-Umgebungsvariablen eintragen, OPENROUTER_API_KEY ergänzen
bun run dev

Das Frontend verlangt derzeit auch die PostHog-Werte in .env.local, siehe Betrieb.

Umfang der Veröffentlichung

Enthalten ist der vollständige Quellcode von Frontend und Backend mit Datenmodell, Schnittstellen, Konfiguration und Skripten.

Nicht enthalten sind:

  • Inhalte der Wissensdatenbank und die Werkzeuge, mit denen GeoMesh sie aufbereitet
  • Produktivkonfiguration, Nutzungsdaten und Zugangsdaten
  • der Veranstaltungskalender kalender-oberhausen.de (nur die Anbindung ist enthalten)
  • Dienste Dritter wie OpenRouter, Convex, Kartenkacheln und die Abfall-Schnittstelle
  • Rechte an Marken und Logos: Die Logos liegen im Repository, stehen aber nicht unter der AGPL (siehe THIRD-PARTY-NOTICES.md).

Nachnutzung durch andere Kommunen

Für einen eigenen Betrieb anzupassen:

  • Texte, Logos, Domain: src/i18n/locales/, public/, index.html
  • Produktanalyse: src/env.ts verlangt PostHog-Werte; ohne PostHog dort optional machen
  • Impressum, Datenschutz, Über-Seite: src/routes/
  • System-Prompt und Vorschlagsfragen: convex/constants.ts, src/lib/suggestions.ts
  • Inhalte der Wissensdatenbank: Upload in der Verwaltung oder über die Context Sync API
  • Abfuhrtermine: Die Anbindung nutzt die Abfall-App-Schnittstelle von Oberhausen (convex/lib/wboApi.ts). Für andere Städte anpassen oder das Werkzeug abschalten.
  • Veranstaltungen: Die Werkzeuge brauchen eine Kalender-API im Format von convex/lib/calendarApi.ts. Ohne eine solche API abschalten.

Mitarbeit und Kontakt