yokai
Simple, modular, and observable Go framework for backend applications.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/ankorstore--yokai)HTML
<a href="/listings/ankorstore--yokai"><img src="/api/listings/ankorstore--yokai/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
Yokai provides ready to use `application templates` to start your projects:
- for [gRPC applications](https://ankorstore.github.io/yokai/getting-started/grpc-application) - for [HTTP applications](https://ankorstore.github.io/yokai/getting-started/http-application) - for [MCP applications](https://ankorstore.github.io/yokai/getting-started/mcp-application) - for [worker applications](https://ankorstore.github.io/yokai/getting-started/worker-application)
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 98 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- # Yokai
- [](https://opensource.org/licenses/MIT)
- [](https://go.dev/)
- [](https://codecov.io/gh/ankorstore/yokai)
- [](https://ankorstore.github.io/yokai/)
- [](https://github.com/avelino/awesome-go)
- <p align="center">
- <img src="docs/assets/images/yokai-bck.png" width="300" />
- </p>
- > Simple, modular, and observable Go framework for backend applications.
- <!-- TOC -->
- * [Goals](#goals)
- * [Documentation](#documentation)
- * [Overview](#overview)
- * [Architecture](#architecture)
- * [Foundations](#foundations)
- * [Extensions](#extensions)
- * [Getting started](#getting-started)
- * [Showroom](#showroom)
- * [Contributing](#contributing)
- <!-- TOC -->
- ## Goals
- Building backend applications with [Go](https://go.dev/) is amazing.
- 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.).
- To solve this, Yokai was created with the following goals in mind:
- - `Simple`: it is easy to use, configure and test, enabling you to iterate fast and deliver quickly maintainable applications.
- - `Modular`: it can be extended with the available Yokai modules, or with your own, to build evolvable applications.
- - `Observable`: it comes with built-in logging, tracing and metrics instrumentation, to build reliable applications.
- In other words, Yokai lets you focus on your application logic, while taking care of the rest.
- ## Documentation
- Yokai's `documentation` is available at [https://ankorstore.github.io/yokai](https://ankorstore.github.io/yokai).
- ## Overview
- ### Architecture
- 
- - Yokai `core modules` preloads logging, tracing, metrics and health check instrumentation, and expose a private HTTP server for infrastructure and debugging needs.
- - 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.
- - Those are made available in Yokai `dependency injection system`, on which you can rely to build your application logic.
- ### Foundations
- Yokai was built using `robust` and `well known` Go libraries, such as:
- - [Echo](https://github.com/labstack/echo) for HTTP servers
- - [gRPC-go](https://github.com/grpc/grpc-go) for gRPC servers
- - [Viper](https://github.com/spf13/viper) for configuration management
- - [OTEL](https://github.com/open-telemetry/opentelemetry-go) for observability instrumentation
- - [Fx](https://github.com/uber-go/fx) for dependency injection system
- - and more.
- ### Extensions
- Yokai's `extension system` enables you to `enrich` your application features with:
- - the Yokai `built-in` modules
- - the Yokai [contrib modules](https://github.com/ankorstore/yokai-contrib)
- - your own modules
- ## Getting started
- Yokai provides ready to use `application templates` to start your projects:
- - for [gRPC applications](https://ankorstore.github.io/yokai/getting-started/grpc-application)
- - for [HTTP applications](https://ankorstore.github.io/yokai/getting-started/http-application)
- - for [MCP applications](https://ankorstore.github.io/yokai/getting-started/mcp-application)
- - for [worker applications](https://ankorstore.github.io/yokai/getting-started/worker-application)
- ## Showroom
- Yokai provides a [showroom repository](https://github.com/ankorstore/yokai-showroom) with `demo applications`, ready to run, to see it in action:
- - [gRPC demo application](https://github.com/ankorstore/yokai-showroom/tree/main/grpc-demo)
- - [HTTP demo application](https://github.com/ankorstore/yokai-showroom/tree/main/http-demo)
- - [MCP demo application](https://github.com/ankorstore/yokai-showroom/tree/main/mcp-demo)
- - [worker demo application](https://github.com/ankorstore/yokai-showroom/tree/main/worker-demo)
- ## Contributing
- This repository uses [release-please](https://github.com/googleapis/release-please) to automate Yokai's modules release process.
- > [!IMPORTANT]
- > You must provide [atomic](https://en.wikipedia.org/wiki/Atomic_commit#Revision_control) and [conventional](https://www.conventionalcommits.org/en/v1.0.0/) commits, as the release process relies on them to determine the version to release and to generate the release notes.
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.