{"id":15137234,"url":"https://github.com/ankorstore/yokai-grpc-template","last_synced_at":"2026-03-04T14:32:33.101Z","repository":{"id":230047394,"uuid":"774258061","full_name":"ankorstore/yokai-grpc-template","owner":"ankorstore","description":"gRPC application template based on the Yokai Go framework. ","archived":false,"fork":false,"pushed_at":"2025-05-08T06:50:57.000Z","size":92,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-08-15T14:55:34.978Z","etag":null,"topics":["dependency-injection","framework","go","golang","grpc","grpc-go","grpc-server","modular","observability","open-telemetry","yokai"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ankorstore.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-03-19T08:23:04.000Z","updated_at":"2025-05-08T06:56:50.000Z","dependencies_parsed_at":"2024-04-05T11:24:35.706Z","dependency_job_id":"d4fef94b-e064-4659-b179-8defdefacdbc","html_url":"https://github.com/ankorstore/yokai-grpc-template","commit_stats":{"total_commits":15,"total_committers":1,"mean_commits":15.0,"dds":0.0,"last_synced_commit":"5b52ad642cabd370e9d422eb71196eefa07f5c35"},"previous_names":["ankorstore/yokai-grpc-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/ankorstore/yokai-grpc-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-grpc-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-grpc-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-grpc-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-grpc-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ankorstore","download_url":"https://codeload.github.com/ankorstore/yokai-grpc-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-grpc-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30083762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T13:22:36.021Z","status":"ssl_error","status_checked_at":"2026-03-04T13:20:45.750Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dependency-injection","framework","go","golang","grpc","grpc-go","grpc-server","modular","observability","open-telemetry","yokai"],"created_at":"2024-09-26T07:00:33.274Z","updated_at":"2026-03-04T14:32:33.057Z","avatar_url":"https://github.com/ankorstore.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yokai gRPC Template\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![Go version](https://img.shields.io/badge/Go-1.24-blue)](https://go.dev/)\n[![Documentation](https://img.shields.io/badge/Doc-online-cyan)](https://ankorstore.github.io/yokai/)\n\n\u003e gRPC application template based on the [Yokai](https://github.com/ankorstore/yokai) Go framework.\n\n\u003c!-- TOC --\u003e\n* [Documentation](#documentation)\n* [Overview](#overview)\n  * [Layout](#layout)\n  * [Makefile](#makefile)\n* [Getting started](#getting-started)\n  * [Installation](#installation)\n    * [With GitHub](#with-github)\n    * [With gonew](#with-gonew)\n  * [Usage](#usage)\n\u003c!-- TOC --\u003e\n\n## Documentation\n\nFor more information about the [Yokai](https://github.com/ankorstore/yokai) framework, you can check its [documentation](https://ankorstore.github.io/yokai).\n\n## Overview\n\nThis template provides:\n\n- a ready to extend [Yokai](https://github.com/ankorstore/yokai) application, with the [gRPC server](https://ankorstore.github.io/yokai/modules/fxgrpcserver/) module installed\n- a ready to use [dev environment](docker-compose.yaml), based on [Air](https://github.com/air-verse/air) (for live reloading)\n- a ready to use [Dockerfile](Dockerfile) for production\n- some examples of [service](internal/service/example.go) and [test](internal/service/example_test.go) to get started\n\n### Layout\n\nThis template is following the [recommended project layout](https://go.dev/doc/modules/layout#server-project):\n\n- `cmd/`: entry points\n- `configs/`: configuration files\n- `internal/`:\n  - `service/`: gRPC service and test examples\n  - `bootstrap.go`: bootstrap\n  - `register.go`: dependencies registration\n- `proto/`: protobuf definition and stubs\n\n### Makefile\n\nThis template provides a [Makefile](Makefile):\n\n```\nmake up      # start the docker compose stack\nmake down    # stop the docker compose stack\nmake logs    # stream the docker compose stack logs\nmake fresh   # refresh the docker compose stack\nmake stubs   # generate gRPC stubs with protoc (ex: make stubs from=proto/example.proto)\nmake test    # run tests\nmake lint    # run linter\n```\n\n## Getting started\n\n### Installation\n\n#### With GitHub\n\nYou can create your repository [using the GitHub template](https://github.com/new?template_name=yokai-grpc-template\u0026template_owner=ankorstore).\n\nIt will automatically rename your project resources and push them, this operation can take a few minutes.\n\nOnce ready, after cloning and going into your repository, simply run:\n\n```shell\nmake fresh\n```\n\n#### With gonew\n\nYou can install [gonew](https://go.dev/blog/gonew), and simply run:\n\n```shell\ngonew github.com/ankorstore/yokai-grpc-template github.com/foo/bar\ncd bar\nmake fresh\n```\n\n### Usage\n\nOnce ready, the application will be available on:\n\n- `localhost:50051` for the application gRPC server\n- [http://localhost:8081](http://localhost:8081) for the application core dashboard\n\nIf you update the [proto definition](proto/example.proto), you can run `make stubs from=proto/example.proto` to regenerate the stubs.\n\nUsage examples with [gRPCurl](https://github.com/fullstorydev/grpcurl):\n\n- with `ExampleService/ExampleUnary`:\n\n```shell\ngrpcurl -plaintext -d '{\"text\":\"hello\"}' localhost:50051 example.ExampleService/ExampleUnary\n{\n  \"text\": \"response from grpc-app: you sent hello\"\n}\n```\n\n- with `ExampleService/ExampleStreaming`:\n\n```shell\ngrpcurl -plaintext -d '@' localhost:50051 example.ExampleService/ExampleStreaming \u003c\u003cEOF\n{\"text\":\"hello\"}\n{\"text\":\"world\"}\nEOF\n{\n  \"text\": \"response from grpc-app: you sent hello\"\n}\n{\n  \"text\": \"response from grpc-app: you sent world\"\n}\n```\n\nYou can use any gRPC clients, for example [Postman](https://learning.postman.com/docs/sending-requests/grpc/grpc-request-interface/) or [Evans](https://github.com/ktr0731/evans).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankorstore%2Fyokai-grpc-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankorstore%2Fyokai-grpc-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankorstore%2Fyokai-grpc-template/lists"}