fizzbuzz

module
v0.0.0-...-6fa6eff Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 22, 2021 License: MIT

README

LBC test fizzbuzz

The fizzbuzz server

This application is a web serverr exposing a fizzbuzz entry point. You can also check a stats entry point in order to get the most used request and its parameters

For mor informations, please install the project et check swagger

Requirements

  • Docker-Compose
  • Docker
  • GNU Make
  • Golang 1.17

Install

make deps Will install utils dependencies on your host (swagger generation & unit test mock generation)

make up Will use docker-compose to build and run your app

Use

This application provide an OpenApi documentation you can check here : swagger, once you have lauched the app

tests

Run make unit-test for unit testing the application

V2. enhancements & comming features :

  • [] Hot reload for dev env with air
  • [] functional tests
  • [] inject dedecated logger
  • [] add pre commit hooks for lint
  • [] add a fixtures file for fizzbuzz builder test for more table cases

Directories

Path Synopsis
cmd
app
pkg
db
docs
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL