go-gin-wrapper

Go-gin-wrapper is wrapper of go gin web framework plus reverseproxy. React by ES6 is used on part of front-end.
gin-gonic/gin

Example

This is built on Heroku. You can see here.

Installation

$ go get github.com/hiromaily/go-gin-wrapper ./...
 or
$ go get github.com/hiromaily/go-gin-wrapper ./cmd/ginserver/...

Setup for local environment with Docker

# it would be better to execute build, up separately for first the build
$ docker-compose build
$ docker-compose up

Configuration

1. Common settings

MySQL

It requires set database and table.
If you want know more details, use docker environment usign docker-create.sh.
This is the easiest way to configure whole environment.

Redis

If you store session data on Redis, Redis is required. But it's not indispensable.

MongoDB

It's used for news information. Another worker program make data regularly.
go-news-mongodb

TOML file

This is for configuration.

$ cp ./configs/settings.default.toml ./configs/settings.toml

When running web server, go-gin-wrapper requires toml file as configuration information.
Without command line arguments for toml file path, this try to read configs/settings.toml.
If you want to use original toml file, use command line arguments -f filepath.

ginserver -f /app/config/yourfile.toml

server
proxy
auth
mysql
redis
mongodb
aws

※ As needed, secret information can be ciphered.(using AES encryption)

Authentication for Login

It's available using Google or Facebook account using OAuth2 authentication.

Authentication for API

It's implemented by JWT(Json Web Token) for authentication. Set [api.auth] on toml file. You can choose HMAC or RSA as signature pattern.

2. On heroku

## Install 
$ heroku create ginserver --buildpack heroku/go

# MySQL
$ heroku addons:create cleardb
$ heroku config | grep CLEARDB_DATABASE_URL

# Redis
$ heroku addons:create heroku-redis:hobby-dev -a ginserver 
$ heroku config | grep REDIS

# MongoDB
* attach mongodb from news-mongo app on heroku because of sharing.
* it's better to attach from dashboard.

## Environment variable
$ heroku config:add HEROKU_FLG=1
$ heroku config:add ENC_KEY=xxxxx
$ heroku config:add ENC_IV=xxxxx

## Check
$ heroku config | grep CLEARDB_DATABASE_URL
$ heroku config | grep REDIS
$ heroku ps -a ginserver

## Deploy
$ git push -f heroku master

Access (For check hot to work)
site on heroku
Heroku environment set configs/heroku.toml when starting to run.

ginserver -f /app/configs/heroku.toml -crypto

3. On Docker

Docker environment set data/toml/docker.toml when starting to run.

Docker related files

docker-compose.yml
docker-compose.override.yml
Dockerfile
./build/docker/*

Environment variable e.g.

1. Common

NAME	Value
ENC_KEY	xxxxx
ENC_IV	xxxxx

2. For Heroku environment

NAME	Value
HEROKU_FLG	1
PORT	8080

Heroku server use PORT automatically as environment variable.

APIs

Documentation is prepared using Swagger swagger

Usage

Usage: ginserver [options...]

Options:
  -f     Toml file path

e.g.
 $ ginserver -f /app/configs/yourfile.toml

Profiling

Set config first.

[profile]
enable = true

After running werserver, acccess tha below links.

[GIN-debug] GET    /debug/pprof/
[GIN-debug] GET    /debug/pprof/heap
[GIN-debug] GET    /debug/pprof/goroutine
[GIN-debug] GET    /debug/pprof/block
[GIN-debug] GET    /debug/pprof/threadcreate
[GIN-debug] GET    /debug/pprof/cmdline
[GIN-debug] GET    /debug/pprof/profile
[GIN-debug] GET    /debug/pprof/symbol
[GIN-debug] POST   /debug/pprof/symbol
[GIN-debug] GET    /debug/pprof/trace

License

kuznetsovsite/go-gin-wrapper

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages