Skip to content

ankorstore/yokai-worker-template

Repository files navigation

Yokai Worker Template

License: MIT Go version Documentation

Worker application template based on the Yokai Go framework.

Documentation

For more information about the Yokai framework, you can check its documentation.

Overview

This template provides:

Layout

This template is following the recommended project layout:

  • cmd/: entry points
  • configs/: configuration files
  • internal/:
    • worker/: worker and test examples
    • bootstrap.go: bootstrap
    • register.go: dependencies registration

Makefile

This template provides a Makefile:

make up     # start the docker compose stack
make down   # stop the docker compose stack
make logs   # stream the docker compose stack logs
make fresh  # refresh the docker compose stack
make test   # run tests
make lint   # run linter

Getting started

Installation

With GitHub

You can create your repository using the GitHub template.

It will automatically rename your project resources and push them, this operation can take a few minutes.

Once ready, after cloning and going into your repository, simply run:

make fresh

With gonew

You can install gonew, and simply run:

gonew github.com/ankorstore/yokai-worker-template github.com/foo/bar
cd bar
make fresh

Usage

Once ready, the application core dashboard will be available on http://localhost:8081.

To see the provided example worker in action, simply run:

make logs