wonjinsin/go-web-boilerplate(pikachu)

Simple rest api server with Echo framework

Features

• Gorm : For mysql ORM
• Go-redis : Go redis client
• Zap : Go leveled Logging
• Viper : Config Setting
• Ginko : BDD Testing Framework with Gomega
• Makefile : go build, test, vendor using Make

Project structure

DDD(Domain Driven Design) pattern with controller, model, servie, repository

Getting started

Set infra

$ docker-compose -f infra-docker.yml up -d

Initial action

$ make all && make build && make start

If you have error when Init Please use below command and do Inital action again

make clean

MakeFile Command

migrate up

# e.g make migrate up ENV=local
$ make migrate up ENV=${ENV}

migrate down

# e.g make migrate down ENV=local
$ make migrate down ENV=${ENV}

Build vendors

$ make vendor

Build and start

$ make build && bin/pikachu

Test

$ make vet && make fmt && make lint && make test
// or
$ make test-all

Clean

$ make clean