README
¶
golang-project-template
What is this？
This is an template for golang project, it has the following features:
- An
Makefilestyle for build、test，support docker - Support addlicense headers
- Buildin grpc、grpc-gateway with example
- Github template and action for PR、ISSUE and workflow
- Go 1.21，with golangci-lint、mockgen and so on, and unittest is enabled
- Codecov enabled
How to use？
- First, create an repository with this template, and clone it
- Second, run
./hack/rename {xxx}to new project name - Third, follow codecov to configration your
CODECOV_TOKEN
Now, enjoy coding!
Directories
¶
| Path | Synopsis |
|---|---|
|
Package main is the entrance of project
|
Package main is the entrance of project |
|
Package main ...
|
Package main ... |
|
Package pb is a reverse proxy.
|
Package pb is a reverse proxy. |
|
pkg
|
|
|
executor
Package executor ...
|
Package executor ... |
|
fsl
Package fsl provide the description and model of FSL
|
Package fsl provide the description and model of FSL |
|
server
Package server provide the HelloServer implement
|
Package server provide the HelloServer implement |
|
server/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
utils
Package utils contains helper function for project
|
Package utils contains helper function for project |
|
utils/jsonpath
Package jsonpath contains the wrapper of jsonpath implemention.
|
Package jsonpath contains the wrapper of jsonpath implemention. |
|
utils/version
Package version provide the information of current project module
|
Package version provide the information of current project module |
|
Package test contains some helper function for unittest and e2e-test
|
Package test contains some helper function for unittest and e2e-test |
Click to show internal directories.
Click to hide internal directories.