Golang CRUD Application Scaffold

About

This code is written with very little experience with Golang. I did my best. CRs and PRs always welcome :)

• go 1.14,
• chi for routing,
• sqlx for mysql database access (I prefer postgres but this is just example),
• tests using testify library
• pkg/errors for better error handling
• spf13/viper for handling config files
• package design inspired by https://www.ardanlabs.com/blog/2017/02/package-oriented-design.html and https://medium.com/statuscode/how-i-write-go-http-services-after-seven-years-37c208122831
• go modules for package management
• dockerized environment

Usage

API

• GET http://localhost:8080/rest/banks/
• GET http://localhost:8080/rest/banks/1
• POST http://localhost:8080/rest/banks/ { "name": "BankName" }
• PUT http://localhost:8080/rest/banks/1 { "name": "BankName" }
• DELETE http://localhost:8080/rest/banks/1
• DELETE http://localhost:8080/rest/banks/

docker-compose

If you want to setup docker environemnt just use ./scripts/docker-compose.yml with docker-compose.

Go to ./scripts directory and execute

# start docker environment
$ docker-compose up -d (--build)

# list running services
$ docker-compose ps

# stop all containers
$ docker-compose stop

# remove all containers
$ docker-compose rm

single docker

• Build app: &docker build -t golang:go-app . && $docker run --name go-crud --network=host -it -d -p 8080:8080 golang:go-app
• You can run localDB with: $docker run -d -p 3306:3306 --name mysql-db -e MYSQL_ROOT_PASSWORD=admin -d mysql:5.7

Run Locally:

• start mysql on 3306 port (and execute db script - manually currently)
• start app from IDE or after install with flag -env=dev and giving -configFilePath, ./go-crud-template -env=dev

Hints

• My $GOPATH=$HOME/go
• Project dir: /home/users/kgoralski/go/src/github.com/kgoralski/go-crud-template
• Database inside Docker? Be warned.

Many thanks to @wendigo for a Code Review!