yokai-worker-template

Yokai Worker Template

Worker application template based on the Yokai Go framework.

• Documentation
• Overview
  • Layout
  • Makefile
• Getting started
  • Installation
    • With GitHub
    • With gonew
  • Usage

Documentation

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

Overview

This template provides:

• a ready to extend Yokai application, with the worker module installed
• a ready to use dev environment, based on Air (for live reloading)
• a ready to use Dockerfile for production
• some examples of worker and test to get started

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/thiruselvaa/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