README.md

gin-skeleton

Gin Skeleton is a simple boilerplate to kickstart a web server project based on Gin Framework.

Require go version >= 1.11, if your go version is 1.10, please use branch go1.10.

# start a web server listening on 0.0.0.0:8080
go run main.go

Components

• Framework: gin-gonic/gin
• Database ORM: jinzhu/gorm
• Database migration: rubenv/sql-migrate
• Leveled logs: golang/glog
• YAML support: go-yaml/yaml
• Testing toolkit: stretchr/testify

Configuration

Edit the config.yml with your own config

Database Migration

Create the database first

CREATE DATABASE IF NOT EXISTS `gin` DEFAULT CHARACTER SET utf8mb4;

Migrates the database to the most recent version available

./migrate.sh up

Undo a database migration

./migrate.sh down

Show migration status

./migrate.sh status

Create a new migration

./migrate.sh new a_new_migration