{"id":15137310,"url":"https://github.com/ankorstore/yokai-worker-template","last_synced_at":"2025-10-23T13:30:29.575Z","repository":{"id":218873602,"uuid":"747269545","full_name":"ankorstore/yokai-worker-template","owner":"ankorstore","description":"Worker application template based on the Yokai Go framework. ","archived":false,"fork":false,"pushed_at":"2024-10-02T10:21:08.000Z","size":138,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-01-30T18:48:13.664Z","etag":null,"topics":["dependency-injection","framework","go","golang","modular","observability","open-telemetry","worker","worker-pool","yokai"],"latest_commit_sha":null,"homepage":"https://ankorstore.github.io/yokai","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}},"created_at":"2024-01-23T15:50:50.000Z","updated_at":"2024-10-02T10:21:11.000Z","dependencies_parsed_at":"2024-03-30T21:25:36.897Z","dependency_job_id":"5169cfbc-1f6f-4e2e-bac7-855c70e60a61","html_url":"https://github.com/ankorstore/yokai-worker-template","commit_stats":{"total_commits":30,"total_committers":1,"mean_commits":30.0,"dds":0.0,"last_synced_commit":"6c60c991411940ca313355b83e8b6aadd9ae23d4"},"previous_names":["ankorstore/yokai-worker-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-worker-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-worker-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-worker-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankorstore%2Fyokai-worker-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ankorstore","download_url":"https://codeload.github.com/ankorstore/yokai-worker-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237827795,"owners_count":19372785,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","modular","observability","open-telemetry","worker","worker-pool","yokai"],"created_at":"2024-09-26T07:00:37.828Z","updated_at":"2025-10-23T13:30:29.570Z","avatar_url":"https://github.com/ankorstore.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yokai Worker 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 Worker 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 [worker](https://ankorstore.github.io/yokai/modules/fxworker/) 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 [worker](internal/worker/example.go) and [test](internal/worker/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  - `worker/`: worker and test examples\n  - `bootstrap.go`: bootstrap\n  - `register.go`: dependencies registration\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 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-worker-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-worker-template github.com/foo/bar\ncd bar\nmake fresh\n```\n\n### Usage\n\nOnce ready, the application core dashboard will be available on [http://localhost:8081](http://localhost:8081).\n\nTo see the [provided example worker](internal/worker/example.go) in action, simply run:\n\n```shell\nmake logs\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankorstore%2Fyokai-worker-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankorstore%2Fyokai-worker-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankorstore%2Fyokai-worker-template/lists"}