Skip to content
Back to search

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.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/ankorstore--yokai/badge.svg)](/listings/ankorstore--yokai)

HTML

<a href="/listings/ankorstore--yokai"><img src="/api/listings/ankorstore--yokai/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

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)

  1. # Yokai
  2. [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
  3. [![Go version](https://img.shields.io/badge/Go-≥1.20-blue)](https://go.dev/)
  4. [![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR)](https://codecov.io/gh/ankorstore/yokai)
  5. [![Documentation](https://img.shields.io/badge/Doc-online-cyan)](https://ankorstore.github.io/yokai/)
  6. [![Awesome Go](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/avelino/awesome-go)
  7. <p align="center">
  8. <img src="docs/assets/images/yokai-bck.png" width="300" />
  9. </p>
  10. > Simple, modular, and observable Go framework for backend applications.
  11. <!-- TOC -->
  12. * [Goals](#goals)
  13. * [Documentation](#documentation)
  14. * [Overview](#overview)
  15. * [Architecture](#architecture)
  16. * [Foundations](#foundations)
  17. * [Extensions](#extensions)
  18. * [Getting started](#getting-started)
  19. * [Showroom](#showroom)
  20. * [Contributing](#contributing)
  21. <!-- TOC -->
  22. ## Goals
  23. Building backend applications with [Go](https://go.dev/) is amazing.
  24. 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.).
  25. To solve this, Yokai was created with the following goals in mind:
  26. - `Simple`: it is easy to use, configure and test, enabling you to iterate fast and deliver quickly maintainable applications.
  27. - `Modular`: it can be extended with the available Yokai modules, or with your own, to build evolvable applications.
  28. - `Observable`: it comes with built-in logging, tracing and metrics instrumentation, to build reliable applications.
  29. In other words, Yokai lets you focus on your application logic, while taking care of the rest.
  30. ## Documentation
  31. Yokai's `documentation` is available at [https://ankorstore.github.io/yokai](https://ankorstore.github.io/yokai).
  32. ## Overview
  33. ### Architecture
  34. ![Architecture](docs/assets/images/architecture.jpg)
  35. - Yokai `core modules` preloads logging, tracing, metrics and health check instrumentation, and expose a private HTTP server for infrastructure and debugging needs.
  36. - 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.
  37. - Those are made available in Yokai `dependency injection system`, on which you can rely to build your application logic.
  38. ### Foundations
  39. Yokai was built using `robust` and `well known` Go libraries, such as:
  40. - [Echo](https://github.com/labstack/echo) for HTTP servers
  41. - [gRPC-go](https://github.com/grpc/grpc-go) for gRPC servers
  42. - [Viper](https://github.com/spf13/viper) for configuration management
  43. - [OTEL](https://github.com/open-telemetry/opentelemetry-go) for observability instrumentation
  44. - [Fx](https://github.com/uber-go/fx) for dependency injection system
  45. - and more.
  46. ### Extensions
  47. Yokai's `extension system` enables you to `enrich` your application features with:
  48. - the Yokai `built-in` modules
  49. - the Yokai [contrib modules](https://github.com/ankorstore/yokai-contrib)
  50. - your own modules
  51. ## Getting started
  52. Yokai provides ready to use `application templates` to start your projects:
  53. - for [gRPC applications](https://ankorstore.github.io/yokai/getting-started/grpc-application)
  54. - for [HTTP applications](https://ankorstore.github.io/yokai/getting-started/http-application)
  55. - for [MCP applications](https://ankorstore.github.io/yokai/getting-started/mcp-application)
  56. - for [worker applications](https://ankorstore.github.io/yokai/getting-started/worker-application)
  57. ## Showroom
  58. Yokai provides a [showroom repository](https://github.com/ankorstore/yokai-showroom) with `demo applications`, ready to run, to see it in action:
  59. - [gRPC demo application](https://github.com/ankorstore/yokai-showroom/tree/main/grpc-demo)
  60. - [HTTP demo application](https://github.com/ankorstore/yokai-showroom/tree/main/http-demo)
  61. - [MCP demo application](https://github.com/ankorstore/yokai-showroom/tree/main/mcp-demo)
  62. - [worker demo application](https://github.com/ankorstore/yokai-showroom/tree/main/worker-demo)
  63. ## Contributing
  64. This repository uses [release-please](https://github.com/googleapis/release-please) to automate Yokai's modules release process.
  65. > [!IMPORTANT]
  66. > 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 in

Free to use. If it’s helped, pass it on.