directus/README.md

1.9 KiB

Directus Plugins

Hier sind die selbst entwickelten Plugins für Directus. Directus bietet für Plugins eine Anleitung sowie vorgefertigte Komponenten.

Liste an Plugins:

  • tasks: Ein Layout für die Task-Liste.
    Diese soll die Übersicht der Aufgaben vereinfachen und funktioniert auch Mobil.

Entwicklung

Um die Entwicklung einfach und einheitlich zu gestalten, benutzen wir Devcontainer in VSCode. Wenn du das Repo in VSCode mit der Devcontainer-Erweiterung öffnest, dann werden alle Tools und Erweiterungen für die Entwicklung automatisch für dich installiert. Wenn du das nicht willst oder kannst, musst du Node von Hand installieren.

Folgende VSCode-Tasks sind definiert:

  • install: Installiert/Updated die Dependencies
  • dev: Startet ein lokales Directus und überwacht auf Code-Änderungen
  • build: Buildet das Plugin

Das lokale Directus ist unter http://localhost:8055 erreichbar und es sind bereits Testdaten angelegt (deshalb die DB im Repo). Der Account ist admin@example.com mit dem Passwort admin.

Änderungen

Wenn du etwas ändern willst oder du einen Fehler bemerkt hast, dann öffne gerne ein Issue und beschreibe möglichst genau dein Problem.

Alternativ kannst du die Änderung auch gerne selbst entwickeln und einen Pull Request stellen.

Deployment

Wenn Änderungen den main-Branch erreichen, wird automatisch eine Pipeline gestartet. Diese baut die Erweiterung und fügt diese in das Directus-Image hinzu. Das Image wird dann als Package gepuhst und dann automatisch von Watchtower regelmäßig aktualisiert.