Das Stud.IP CheckIn Plugin ermöglicht es, nach dem Login gezielt Formulare an spezifische Nutzergruppen auszuspielen. Administrierende können genau festlegen, welche Zielgruppen beim Einstieg in die Plattform adressiert werden, um notwendige Rückmeldungen, Zustimmungen oder Datenerfassungen direkt und effizient einzuholen.
Bevor Sie das Plugin installieren oder entwickeln, stellen Sie sicher, dass folgende Werkzeuge auf Ihrem System installiert sind:
- Node.js
- npm
- Composer
Wenn Sie ein fertiges Release-Paket (ZIP-Datei) haben, können Sie dieses direkt über die Plugin-Verwaltung in Stud.IP hochladen.
Falls Sie das Plugin aus dem Quellcode installieren möchten:
- Klonen Sie das Repository in das Verzeichnis public/plugins_packages/elan-ev/StudipCheckin Ihrer Stud.IP-Installation.
- Navigieren Sie in das Plugin-Verzeichnis.
- Führen Sie den kombinierten Build-Befehl aus:
npm run prezip
Dieser Befehl installiert alle Node-Abhängigkeiten, baut die JavaScript-Assets im dist-Ordner und installiert die PHP-Vendor-Bibliotheken via Composer. 4. Aktivieren Sie das Plugin in der Stud.IP-Plugin-Verwaltung.
Um aktiv am Plugin zu arbeiten, können Sie den Development-Modus nutzen.
Stellen Sie sicher, dass die Composer-Autoload-Dateien vorhanden sind:
composer install
- Installieren Sie die Abhängigkeiten:
npm install
- Starten Sie den Watch-Modus für die Assets:
npm run dev
Vite überwacht nun Änderungen im src-Verzeichnis und baut die Dateien im dist-Ordner automatisch neu.
Das Plugin nutzt vue3-gettext für Übersetzungen. Um neue Texte zu extrahieren oder zu kompilieren:
- Texte extrahieren: npm run gettext:extract (Sucht nach neuen $gettext-Aufrufen im Code).
- Übersetzungen kompilieren: npm run gettext:compile (Wandelt die .po-Dateien in für Vue lesbare Formate um).
Um ein installationsfertiges ZIP-Archiv für den Upload in andere Stud.IP-Systeme zu erstellen, nutzen Sie:
npm run zip
Die fertige Datei finden Sie anschließend im Hauptverzeichnis des Plugins.
Dieses Projekt ist unter der GPL-3.0 lizenziert. Weitere Details finden Sie in der LICENSE-Datei. In der Datei LICENSE-SUPPLEMENT finden Sie weitere Bedingungen gem. Abschnitt 7 der GPL-3.0
Autoren: Ron Lucke & Farbod Zamani (elan e.V.) Homepage: elan-ev.de