https://github.com/mrflynn/golang-project-template
:construction: Opinionated repository structure for projects written in Go.
https://github.com/mrflynn/golang-project-template
github-actions github-container-registry golang goreleaser repository-template
Last synced: about 1 month ago
JSON representation
:construction: Opinionated repository structure for projects written in Go.
- Host: GitHub
- URL: https://github.com/mrflynn/golang-project-template
- Owner: MrFlynn
- Created: 2021-06-01T00:35:49.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T06:16:19.000Z (over 1 year ago)
- Last Synced: 2025-03-02T08:28:36.277Z (over 1 year ago)
- Topics: github-actions, github-container-registry, golang, goreleaser, repository-template
- Language: Shell
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# golang-project-template
An opinionated repository structure for projects written in Go. This repository
contains the common configurations I use across my Go projects. Each of these
configuration files contain what I would consider to be "sane" defaults.
This project template is also very Github-oriented. It uses Github Actions and
the Github Container Registry (GHCR). If you wish to use this template elsewhere
just note that you will have to make fairly significant changes to make it work.
## Getting Started
1. Click _Use this template_ above to create a repository using this template.
Follow Github's prompts.
2. Clone the new repository you just made.
3. Run the following shell script to substitute all of the placeholder variables
in all of the configuration files. When prompted, enter the name of the
project's license.
```bash
$ ./substitute.sh
```
4. Delete the substitution script and edit this file.
```
$ git rm substitute.sh
$ $EDITOR README.md
```