yokai-test

README

Yokai HTTP Template

HTTP application template based on the Yokai Go framework.

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

Overview

This template provides:

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

Documentation

See Yokai documentation.

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/ekkinox/yokai-test github.com/foo/bar
cd bar
make fresh

Usage

Once ready, the application will be available on:

• http://localhost:8080 for the application HTTP server
• http://localhost:8081 for the application core dashboard

Contents

Layout

This template is following the standard Go project layout:

• cmd/: entry points
• configs/: configuration files
• internal/:
  • handler/: handler and test examples
  • bootstrap.go: bootstrap (modules, lifecycles, etc)
  • routing.go: routing
  • services.go: dependency injection

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