https://github.com/zeiss/template-go

A tiny template to start Go projects
https://github.com/zeiss/template-go

Last synced: 4 months ago
JSON representation

A tiny template to start Go projects

• Host: GitHub
• URL: https://github.com/zeiss/template-go
• Owner: ZEISS
• Created: 2024-03-08T13:21:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-19T09:28:01.000Z (4 months ago)
• Last Synced: 2025-02-19T10:29:27.313Z (4 months ago)
• Language: Makefile
• Homepage:
• Size: 900 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# :partying_face: Template Go

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/ZEISS/template-go?quickstart=1)

> 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](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).

## Get Started

This template supports `Makefile` to run tooling.

> `make` is choosen as it is available on most systems.

```bash

# show `help`

make help

```

Other available targets are

```bash

build                          Build the binary file.

clean                          Remove previous build.

fmt                            Run go fmt against code.

generate                       Generate code.

help                           Display this help screen.

lint                           Run lint.

mocks                          Generate mocks.

release                        Release the project.

test                           Run tests.

vet                            Run go vet against code.

```

The convention is to use `make` to run the build.

Happy coding!