gostarter

README

GoLang project Template

A simple Golang project template to save you time and energy.

A simple GoLang boiler plate project to accelerate Golang projects.

Install

Click the Use this template button at the top of this project's GitHub page to get started.

Usage

Setup configuration

1. Configure the go.mod file and replace module github.com/AaronSaikovski/gostarter with your specific project url.
2. Configure the Makefile targets and parameters
3. Update the name in the LICENSE or swap it out entirely
4. Configure the .github/workflows/build.yml file
5. Update the CHANGELOG.md with your own info
6. Rename other files/folders as needed and configure their content
7. Delete this README and rename README_project.md to README.md
8. Run go mod tidy to ensure all the modules and packages are in place.
9. The build process is run from the Makefile and to test the project is working type: make run and check the console for output.

Build and run

run make help for more assistance on the make file.

1. make build - To make and build the program using the Makefile.
2. make run - To make and run the program using the Makefile.
3. make test - To make and run the unit tests using the Makefile.
4. make clean - To cleanup and delete all binaries using the Makefile.
5. make lint - To lint the code using golangci-lint via the Makefile.
6. make dep - To download all program dependencies using Makefile.