SourceAnt

Entwicklerdokumentation

Dieser Abschnitt bietet Ressourcen für Entwickler, die zum SourceAnt-Projekt beitragen oder seine Funktionsweise verstehen möchten.

Mitwirken

Wir freuen uns über Beiträge! So können Sie helfen:

  1. Forken Sie das Repository.
  2. Erstellen Sie einen neuen Branch: git checkout -b feature/your-feature
  3. Nehmen Sie Ihre Änderungen vor und committen Sie sie: git commit -m 'Add some feature'
  4. Pushen Sie zum Branch: git push origin feature/your-feature
  5. Reichen Sie einen Pull Request ein.

SourceAnt-Befehle

Der sourceant Der Befehl bietet Unterbefehle zur Verwaltung der Anwendung:

  • docker compose exec app sourceant db upgrade head: Datenbanktabellen einrichten.
  • docker compose exec app sourceant db --help: Weitere Datenbankbefehle anzeigen.

Warteschlangen-Modi

Die Anwendung unterstützt verschiedene Backend-Modi für die Verarbeitung von Hintergrundjobs, gesteuert durch die QUEUE_MODE Umgebungsvariable.

  • redis: Der empfohlene Modus für die Produktion. Er verwendet eine persistente Redis-Warteschlange (rq).
  • redislite: Eine eigenständige, dateibasierte Redis-Warteschlange, ideal für die lokale Entwicklung.
  • request: Verwendet FastAPIs BackgroundTasks für eine einfache, prozessinterne Jobverarbeitung. Nicht für die Produktion geeignet.

Plugin-System

SourceAnt verfügt über ein leistungsstarkes Plugin-System zur Erweiterung der Funktionalität. Siehe die Ein Plugin erstellen Anleitung für die vollständige Dokumentation zur Erstellung eigener Plugins.