Go project structure

This is a possible structure for a Go project exposing web services and a frontend application.

It is influenced by https://github.com/golang-standards/project-layout

Development workflow

To start the application you can use:

make

The following command will execute the linters locally, and is designed to be used before filing a pull request:

make check

How to create your application from this template

Use the script in scripts/rename.sh to rename it to your project name:

./scripts/rename.sh github.com/myname/myproject myproject

How to configure the release workflow

The release workflow need a personal access token to work. The automatic GITHUB_TOKEN access token doesn't allow to start workflow from other workflows, and this is needed for the image building process.

You can generate a personal access token following the GitHub documentation. IMPORTANT: you'll need to use a classic personal access token as the fine-grained personal access token don't work correctly. The token should have permission to read and write from the repository and to manage the workflows.

Once you have your token (it starts with ghp_) you need to create a GitHub action secret named REPO_PAT, whose value is the token itself. Do that following the instructions in the GitHub documentation.