go-service-template

My opinionated view on how a generic Golang service project(along with its code skeleton) should look like.

Directory structure explanation

.                       # root service dir
├── Dockerfile
├── Makefile
├── README.md
├── bin                 # All build artifacts go here.
├── deploy              # Various deployment scripts(if any) go here.
│   └── README.md
├── docker-compose.yml
├── main.go             # The main entry point of the app. Keep this file as the only .go file at this level.
├── pkg                 # All go app-related packages should go here
│   ├── README.md
│   ├── cli             # A package to incapsulate all CLI commands and the entrypoint for command invocation.
│   │   ├── cli.go
│   │   └── create.go
│   └── srv             # A package to incapsulate all the code about server side.
│       └── srv.go
├── scripts             # All build/admin related scripts for _this_ project go here.
    └── build.sh

Generate service skeleton

This repo also contains a compilable code generator that can create the service structure discussed above. To do this perform the following steps:

go get github.com/nchern/go-service-template/go-svc-generator  # get the utility

cd <somewhere-under-gopath>

go-svc-generator -create my-cool-service  # will create all the code files under ./my-cool-service

Not covered yet

• Dependency management(e.g. glide)
• Coverage tool(go-coverage)
• Codegen examples