Golang Template

A Golang project template to save you time and energy.

Golang projects take a long time to setup with all the various files and keeping things uniform across projects. With this Golang template, you can quickly setup boilerplate code and miscellaneous items for your Golang project saving you time and energy so you can get back to coding.

Install

Click the Use this template button at the top of this project's GitHub page, it looks like this:

Usage

Easy text replacements

1. Replace all occurances of USERNAME
2. Replace all occurances of GO_PROJECT_NAME

File configuration

1. Change the name of the package folder to match your project
2. Configure the go.mod file
3. Configure the Makefile targets
4. Update the name in the LICENSE file
5. Configure the .github/workflows/build.yml file
6. Configure the .goreleaser.yml file and uncomment the last section of the .github/workflows/release.yml file
7. Update the CHANGELOG.md
8. Rename other files/folders as needed and configure their content
9. Add a HOMEBREW_TAP_TOKEN secret to your repo with a value of a GitHub token that has repo access to your homebrew tap
10. Delete this README and rename README_project.md to README.md