Skip to content

Latest commit

 

History

985 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

StatO Logo

StatO

Statistik und Dokumentation für die Offene Kinder- und Jugendarbeit.

Build-Status MIT-Lizenz TypeScript

Schnellstart · On-Prem betreiben · Architektur · Beitragen

StatO hilft Teams, Leitungen und Trägern, Angebote der OKJA nachvollziehbar zu dokumentieren, auszuwerten und sicher im Team zu bearbeiten. Die Anwendung kann selbst im eigenen Netz betrieben oder zentral gehostet werden.

Wofür StatO gedacht ist

  • Angebote, Projekte, Veranstaltungen und aufsuchende Arbeit einheitlich erfassen
  • Teilnehmendenzahlen, Alterskohorten, Kategorien und Tags auswerten
  • Logbuch, Übergaben und Nachbesprechungen an einem Ort führen
  • Rollen, Organisationen und Zugriffe sauber verwalten
  • Daten als Excel-, PDF- und Controlling-Export weiterverwenden

StatO speichert keine personenbezogenen Daten von teilnehmenden jungen Menschen. Erfasst werden aggregierte Zählwerte und fachliche Dokumentation.

Funktionen im Überblick

Bereich Was StatO bietet
Aktivitäten Erfassung von Datum, Dauer, Ort, Projekt, Teilnehmendenzahlen, Kategorien, Tags und Notizen
Logbuch Beobachtungen, Übergaben, Kommentare und Status für die gemeinsame Nachverfolgung
Statistik Kennzahlen, Zeitreihen, Verteilungen und filterbare Auswertungen
Exporte Rohdaten, formatierte Excel-Arbeitsmappen, PDF-Berichte und Controllingdaten
Organisation Rollen, Mandanten/Organisationen, Audit-Informationen und konfigurierbare Taxonomien
Betrieb Docker-Deployment, PWA-Unterstützung und On-Prem-Betrieb im eigenen Netzwerk

Schnellstart

StatO starten: betreuter Zugang, eigener Server oder NAS

Für die IT: Betriebsblatt mit Backup, Wiederherstellung und Updates.

Bereits installiert – was ist der nächste Schritt?

Ich möchte … Anleitung
eine Variable ändern und wirksam übernehmen Konfiguration anwenden
Dev lokal mit Docker testen oder Dev-Tools aktivieren Lokale Testinstanz und Build
Code pushen und den neuen Stand testen Push, Image-Build und Containerupdate
eine bestehende Installation aktualisieren Release-Update im bisherigen Ordner

VITE_*-Variablen benötigen einen Frontend-Build. Ein Push nach dev allein aktualisiert keine laufende Installation.

On-Prem mit Docker

Voraussetzung sind Docker und das Docker-Compose-Plugin. Der Installer lädt ein versioniertes Release-Bundle, prüft dessen SHA-256-Summe, erzeugt individuelle Secrets und legt die echte Konfiguration getrennt unter config/stato.env ab.

Linux/macOS:

curl -fsSL https://github.com/Hubertoink/stato_okja/releases/latest/download/install-onprem.sh | sh

Windows PowerShell:

irm https://github.com/Hubertoink/stato_okja/releases/latest/download/install-onprem.ps1 | iex

Danach ist StatO standardmäßig unter http://localhost beziehungsweise der IP-Adresse des Servers erreichbar. Ist Port 80 bei einer neuen lokalen Installation bereits belegt, wählt der Installer automatisch einen freien Port zwischen 8080 und 8090 und zeigt die Adresse an. Die vollständige Anleitung, einschließlich SMTP, Domain und Branding, steht in der Docker-On-Prem-Anleitung.

Für interne HTTPS-Installationen mit Caddy gibt es zusätzlich die Anleitung Caddy internes TLS.

Für die Installation als Custom-App auf einem ZimaOS-NAS steht eine eigene ZimaOS-Anleitung mit importierbarer Compose-Datei zur Verfügung.

Lokale Entwicklung

npm install
docker compose up -d

# Terminal 1
npm run dev:backend

# Terminal 2
npm run dev:frontend

Weitere Hinweise: Erste Schritte und Umgebungsvariablen.

Architektur und Betrieb

StatO ist als TypeScript-Monorepo aufgebaut:

  • Frontend: React, Vite, React Query, Tailwind CSS und PWA-Unterstützung
  • Backend: NestJS, TypeORM, JWT-basierte Anmeldung und rollenbasierte Berechtigungen
  • Datenhaltung: PostgreSQL im Betrieb, S3-kompatibler Dateispeicher über MinIO
  • Deployment: Docker Compose für On-Prem- und Hosted-Szenarien

Details: Architektur, On-Prem-Betrieb und Mittwald-Deployment.

Projektstatus und Roadmap

StatO wird aktiv weiterentwickelt. Die aktuelle Orientierung für Produkt, Betrieb und Community findet sich in der Roadmap. Änderungen zwischen Versionen stehen im Changelog.

Mitwirken

Beiträge, Fehlerberichte und fachliches Feedback aus der OKJA sind willkommen. Bitte lies vor dem Einstieg den Beitragsleitfaden. Sicherheitsrelevante Hinweise bitte nicht öffentlich als Issue melden, sondern nach SECURITY.md.

Lizenz und Kontakt

StatO steht unter der MIT-Lizenz. Fragen und Rückmeldungen: support@okja-stato.de.

About

Statistic and Documentation App

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages