https://github.com/szuecs/go-gin-webapp

Go Gin Webapp template project
https://github.com/szuecs/go-gin-webapp

Last synced: 2 months ago
JSON representation

Go Gin Webapp template project

• Host: GitHub
• URL: https://github.com/szuecs/go-gin-webapp
• Owner: szuecs
• License: mit
• Created: 2016-03-22T16:27:48.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-07T17:33:47.000Z (almost 7 years ago)
• Last Synced: 2024-10-02T09:08:32.745Z (3 months ago)
• Language: Go
• Size: 5.21 MB
• Stars: 9
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# go-gin-webapp

Go Gin Webapp is a template project, that you can use to build your

RESTful microservices using [Gin](https://github.com/gin-gonic/gin) in

similar to [this blogpost](http://txt.fliglio.com/2014/07/restful-microservices-in-go-with-gin/).

It defaults the configuration to use https, if you configure the paths

to Certificate and Key correctly.

[Gin-gomonitor](https://github.com/szuecs/gin-gomonitor)

provides default metrics and you can easily implement your own

metrics, if you need.

It uses [gin-glog](https://github.com/szuecs/gin-glog)

middleware, which internally uses [glog](https://github.com/golang/glog) as

logger. This provides you leveled Logs, commandline options and logs

are flushed to disk in a separate goroutine with a configurable interval.

An [OAuth2 middleware](https://github.com/zalando/gin-oauth2)

supports you to secure your web applications, if you need

authentication and authorization.

## Usage

To create a new web application, you can do the following steps

    # osx need to set SED=gsed, because it uses sed -i (inplace)

    make create.app APP=myapp REPO_USER=github.com/szuecs SED=gsed 

The main package and function of the service is in

cmd/$APP/server.go. It parses flags and merges the configuration to

start the service. A client main package can be find in

cmd/$APP-cli/client.go.

The api package bootstraps the http(s) microservice, middleware,

registers the path specific handlers and you implement handlers

(similar to Controller in MVC) there.

The client package implements a client, that calls your api endpoints.

Configuring your service and client, use the following make target:

    % make config

Create a docker container from your current git tagged release, it

will automatically create scm-source.json for you and you git tools to

get the tagged version from your local tree:

    % make build.docker

    % make build.push    # if you want to build and push

Create a rkt container from your current git tagged release:

    % make build.rkt