$git clone https://github.com/ankorstore/yokai> Simple, modular, and observable Go framework for backend applications.
| 1 | # Yokai |
| 2 | |
| 3 | [](https://opensource.org/licenses/MIT) |
| 4 | [](https://go.dev/) |
| 5 | [](https://codecov.io/gh/ankorstore/yokai) |
| 6 | [](https://ankorstore.github.io/yokai/) |
| 7 | [](https://github.com/avelino/awesome-go) |
| 8 | |
| 9 | <p align="center"> |
| 10 | <img src="docs/assets/images/yokai-bck.png" width="300" /> |
| 11 | </p> |
| 12 | |
| 13 | > Simple, modular, and observable Go framework for backend applications. |
| 14 | |
| 15 | <!-- TOC --> |
| 16 | * [Goals](#goals) |
| 17 | * [Documentation](#documentation) |
| 18 | * [Overview](#overview) |
| 19 | * [Architecture](#architecture) |
| 20 | * [Foundations](#foundations) |
| 21 | * [Extensions](#extensions) |
| 22 | * [Getting started](#getting-started) |
| 23 | * [Showroom](#showroom) |
| 24 | * [Contributing](#contributing) |
| 25 | <!-- TOC --> |
| 26 | |
| 27 | ## Goals |
| 28 | |
| 29 | Building backend applications with [Go](https://go.dev/) is amazing. |
| 30 | |
| 31 | But to build `production-grade` applications, you need to put in place a bunch of efforts and boilerplate code, introducing complexity not even related to the logic of your application (like dependencies wiring, configuration management, observability instrumentation, etc.). |
| 32 | |
| 33 | To solve this, Yokai was created with the following goals in mind: |
| 34 | |
| 35 | - `Simple`: it is easy to use, configure and test, enabling you to iterate fast and deliver quickly maintainable applications. |
| 36 | - `Modular`: it can be extended with the available Yokai modules, or with your own, to build evolvable applications. |
| 37 | - `Observable`: it comes with built-in logging, tracing and metrics instrumentation, to build reliable applications. |
| 38 | |
| 39 | In other words, Yokai lets you focus on your application logic, while taking care of the rest. |
| 40 | |
| 41 | ## Documentation |
| 42 | |
| 43 | Yokai's `documentation` is available at [https://ankorstore.github.io/yokai](https://ankorstore.github.io/yokai). |
| 44 | |
| 45 | ## Overview |
| 46 | |
| 47 | ### Architecture |
| 48 | |
| 49 |  |
| 50 | |
| 51 | - Yokai `core modules` preloads logging, tracing, metrics and health check instrumentation, and expose a private HTTP server for infrastructure and debugging needs. |
| 52 | - Yokai `extensions modules` can be added to enrich your application features, like public HTTP / gRPC servers, workers, ORM, etc. You can also add the [contrib modules](https://github.com/ankorstore/yokai-contrib) or your own. |
| 53 | - Those are made available in Yokai `dependency injection system`, on which you can rely to build your application logic. |
| 54 | |
| 55 | ### Foundations |
| 56 | |
| 57 | Yokai was built using `robust` and `well known` Go libraries, such as: |
| 58 | |
| 59 | - [Echo](https://github.com/labstack/echo) for HTTP servers |
| 60 | - [gRPC-go](https://github.com/grpc/grpc-go) for gRPC servers |
| 61 | - [Viper](https://github.com/spf13/viper) for configuration management |
| 62 | - [OTEL](https://github.com/open-telemetry/opentelemetry-go) for observability instrumentation |
| 63 | - [Fx](https://github.com/uber-go/fx) for dependency injection system |
| 64 | - and more. |
| 65 | |
| 66 | |
| 67 | ### Extensions |
| 68 | |
| 69 | Yokai's `extension system` enables you to `enrich` your application features with: |
| 70 | |
| 71 | - the Yokai `built-in` modules |
| 72 | - the Yokai [contrib modules](https://github.com/ankorstore/yokai-contrib) |
| 73 | - your own modules |
| 74 | |
| 75 | ## Getting started |
| 76 | |
| 77 | Yokai provides ready to use `application templates` to start your projects: |
| 78 | |
| 79 | - for [gRPC applications](https://ankorstore.github.io/yokai/getting-started/grpc-application) |
| 80 | - for [HTTP applications](https://ankorstore.github.io/yokai/getting-started/http-application) |
| 81 | - for [MCP applications](https://ankorstore.github.io/yokai/getting-started/mcp-application) |
| 82 | - for [worker applications](https://ankorstore.github.io/yokai/getting-started/worker-application) |
| 83 | |
| 84 | ## Showroom |
| 85 | |
| 86 | Yokai provides a [showroom repository](https://github.com/ankorstore/yokai-showroom) with `demo applications`, ready to run, to see it in action: |
| 87 | |
| 88 | - [gRPC demo application](https://github.com/ankorstore/yokai-showroom/tree/main/g |