katallaxie / template-go

A tiny template to start Go projects

🥳 Template Go

This is the standard template for Go projects of @katallaxie.

This is a GitHub Template Repository. You can use the green button to create a new repository based on this template. Read more about GitHub Template Repositories.

Get Started

make setup MODULE_NAME=github.com/username/repo

Features

• Development Containers
• Editorconfig
• GoReleaser
• Hexagonal Architecture
• GitHub Actions (lint, test, build, release)

You can sh scripts/postCreateCommand.sh if you are not running in a remote container or on Codespaces.

Usage

This template supports Makefile to run tooling.

make is choosen as it is available on most systems.

# show `help`
make help

Setup

Setup the project.

make setup MODULE_NAME=github.com/username/repo

Other available targets are

• build
• fmt
• lint
• vet
• generate
• clean

The convention is to use make to run the build.

Happy coding!