yokai

Yokai

Einfaches, modulares und beobachtbares Go-Framework für Backend-Anwendungen.

• Ziele
• Dokumentation
• Überblick
  • Architektur
  • Stiftungen
  • Erweiterungen
• Erste Schritte
• Ausstellungsraum
• Mitwirken

Ziele

Das Erstellen von Backend-Anwendungen mit Go ist erstaunlich.

Um jedoch production-grade Anwendungen zu erstellen, müssen Sie eine Menge Aufwand betreiben und Boilerplate-Code erstellen, was Komplexität mit sich bringt, die nicht einmal etwas mit der Logik Ihrer Anwendung zu tun hat (z. B. Abhängigkeitsverknüpfung, Konfigurationsmanagement, Observability-Instrumentierung usw.).

Um dieses Problem zu lösen, wurde Yokai mit folgenden Zielen entwickelt:

• Simple : Es ist einfach zu verwenden, zu konfigurieren und zu testen, sodass Sie schnell iterieren und schnell wartbare Anwendungen bereitstellen können.
• Modular : Es kann mit den verfügbaren Yokai-Modulen oder mit Ihren eigenen erweitert werden, um entwicklungsfähige Anwendungen zu erstellen.
• Observable : Es verfügt über integrierte Protokollierung, Ablaufverfolgung und Metrikinstrumentierung, um zuverlässige Anwendungen zu erstellen.

Mit anderen Worten: Mit Yokai können Sie sich auf Ihre Anwendungslogik konzentrieren und sich um den Rest kümmern.

Dokumentation

documentation von Yokai ist unter https://ankorstore.github.io/yokai verfügbar.

Überblick

Architektur

• Die Yokai- core modules laden Protokollierung, Ablaufverfolgung, Metriken und Integritätsprüfungsinstrumente vor und stellen einen privaten HTTP-Server für Infrastruktur- und Debugging-Anforderungen bereit.
• Yokai extensions modules können hinzugefügt werden, um Ihre Anwendungsfunktionen zu erweitern, z. B. öffentliche HTTP-/gRPC-Server, Worker, ORM usw. Sie können auch die Contrib-Module oder Ihre eigenen hinzufügen.
• Diese werden im Yokai- dependency injection system zur Verfügung gestellt, auf das Sie sich beim Aufbau Ihrer Anwendungslogik verlassen können.

Stiftungen

Yokai wurde unter Verwendung robust und well known Go-Bibliotheken erstellt, wie zum Beispiel:

• Echo für HTTP-Server
• gRPC-go für gRPC-Server
• Viper für Konfigurationsmanagement
• OTEL für Observability-Instrumentierung
• Fx für das Abhängigkeitsinjektionssystem
• und mehr.

Erweiterungen

Mit extension system von Yokai können Sie Ihre Anwendungsfunktionen enrich um:

• die built-in Module
• die Yokai-Beitragsmodule
• Ihre eigenen Module

Erste Schritte

Yokai bietet gebrauchsfertige application templates zum Starten Ihrer Projekte:

• für gRPC-Anwendungen
• für HTTP-Anwendungen
• für Arbeitnehmeranwendungen

Ausstellungsraum

Yokai stellt ein Showroom-Repository mit betriebsbereiten demo applications zur Verfügung, um sie in Aktion zu sehen:

• gRPC-Demoanwendung
• HTTP-Demoanwendung
• Arbeiter-Demoanwendung

Mitwirken

Dieses Repository verwendet „Release-Please“, um den Release-Prozess der Yokai-Module zu automatisieren.

Wichtig

Sie müssen atomare und konventionelle Commits bereitstellen, da der Veröffentlichungsprozess auf ihnen basiert, um die zu veröffentlichende Version zu bestimmen und die Versionshinweise zu generieren.