Simple, modular, and observable Go framework.
Yokai's documentation will be available soon.
Yokai is using Fx for its plugin system.
Yokai's Fx modules are the plugins for your Yokai application.
| Fx Module | Description |
|---|---|
| fxconfig | Fx module for config |
| fxgenerate | Fx module for generate |
| fxhealthcheck | Fx module for healthcheck |
| fxhttpclient | Fx module for httpclient |
| fxhttpserver | Fx module for httpserver |
| fxlog | Fx module for log |
| fxmetrics | Fx module for prometheus |
| fxorm | Fx module for orm |
| fxtrace | Fx module for trace |
They can also be used in any Fx based Go application.
Yokai's modules are the foundation of the framework.
| Module | Description |
|---|---|
| config | Config module based on Viper |
| generate | Generation module based on Google UUID |
| healthcheck | Health check module compatible with K8s probes |
| httpclient | Http client module based on net/http |
| httpserver | Http server module based on Echo |
| log | Logging module based on Zerolog |
| orm | ORM module based on Gorm |
| trace | Tracing module based on OpenTelemetry |
They can also be used in any Go application (no Yokai or Fx dependencies).
This repository uses release-please to automate Yokai's modules release process.
Important
You must provide atomic and conventional commits, since the release process uses them to determinate the releases version and notes to perform.