Golang Seed
Small starter project to play around with golang features, github actions and various pipelines.
Features
todo:
- circuit breaker
- profiler
- test
endpoints
GET /health
GET /docs
GET /v1/hello
GET /v1/time
GET /web/
GET /v1/users
GET /v1/devices
POST /v1/user
POST /v1/device
build
go build ./...
tests
go test ./... -v -covermode=count -coverprofile=coverage.out
or
make test
make test-coverage
generate-binary
go build -a -o seed-go-img cmd/Main.go
or
make build
create docker
make docker
run docker
make docker-run
some docs
license
code of conduct
project structure
├── api
├── cmd
├── docs
├── internal
└── web
name |
descriptions |
api |
swagger api, any protocol and schema file are here |
cmd |
main application lives here |
docs |
design and user documentations collected here |
internal |
internal application and libraries are here |
web |
web static files, htmls and css stored here |
Further information see:
- Golang Project Structure
- Golang standard project layout
integrations
Using some free ci tools and code quality scanners. There's some really great tools for public projects, trying them here.
fork. clone. contribute and share!