Skip to content

Latest commit

 

History

History
110 lines (82 loc) · 3.28 KB

README.md

File metadata and controls

110 lines (82 loc) · 3.28 KB
Raw

cookiecutter-golang

Powered by Cookiecutter, Cookiecutter Golang is a framework for jumpstarting production-ready go projects quickly.

Features

  • Generous Makefile with management commands
  • injects build time and git hash at build time.

Optional Integrations

  • Can use viper for env var config
  • Can use cobra for cli tools
  • Can use logrus for logging
  • Can create dockerfile for building go binary and dockerfile for final go binary (no code in final container)
  • If docker is used adds docker management commands to makefile
  • Option of TravisCI, CircleCI or None

Constraints

  • Only maintained 3rd party libraries are used.

This project now uses docker multistage builds, you need at least docker version v17.05.0-ce to use the docker file in this template, you can read more about multistage builds here.

Docker

This template uses docker multistage builds to make images slimmer and containers only the final project binary and assets with no source code whatsoever.

You can find the image dokcer file in this repo and more information about docker multistage builds in this blog post.

Apps run under non root user and also with dumb-init.

Usage

Let's pretend you want to create a project called "echoserver". Rather than starting from scratch maybe copying some files and then editing the results to include your name, email, and various configuration issues that always get forgotten until the worst possible moment, get cookiecutter to do all the work.

First, get Cookiecutter. Trust me, it's awesome:

$ pip install cookiecutter

Alternatively, you can install cookiecutter with homebrew:

$ brew install cookiecutter

Finally, to run it based on this template, type:

$ cookiecutter https://github.com/mbreban/cookiecutter-golang.git

You will be asked about your basic info (name, project name, app name, etc.). This info will be used to customize your new project.

Warning: After this point, change 'Luis Morales', 'mbreban', etc to your own information.

Answer the prompts with your own desired options. For example:

  [1/14] full_name (Mathieu Bréban): 
  [2/14] github_username (mbreban): 
  [3/14] app_name (mygolangproject): echoserver
  [4/14] project_short_description (A Golang project.): Awesome Echo Server
  [5/14] Select golang_version
    1 - 1.21
    2 - 1.22
    Choose from [1/2] (1): 
  [6/14] docker_build_image (golang:1.21-alpine): 
  [7/14] docker_image (alpine:latest): 
  [8/14] use_docker (y): 
  [9/14] use_git (y): 
  [10/14] use_logrus_logging (y): 
  [11/14] use_viper_config (y): 
  [12/14] use_cobra_cmd (y): 
  [13/14] Select use_ci
    1 - travis
    2 - circle
    3 - none
    Choose from [1/2/3] (1): 
  [14/14] go_mod (y):

Enter the project and take a look around:

$ cd echoserver/
$ ls

Run make help to see the available management commands, or just run make build to build your project.

$ make help
$ make build
$ ./bin/echoserver