scaffold

README

webapp-scaffold

scaffold for go webapp

This is a scaffold for moetang projects.

Dependencies

• Pgx Postgres Driver: github.com/jackc/pgx
• Afero File System API: github.com/spf13/afero
• Toml: github.com/pelletier/go-toml
• Gin: github.com/gin-gonic/gin

Features

TBD

TODO List

• User/Identity integration
• Session framework
• Multiple language

Addons

• pg query orm: struct tag - "mx.orm"

Documentation

Index

• Variables
• func ReadCustomConfig(file string, s interface{}) error
• type GinApi
• type PostgresApi
• type ScaffoldLifecycle
• type WebappScaffold
  • func NewFromConfigFile(file string) (*WebappScaffold, error)
  • func (w *WebappScaffold) GetGin() *gin.Engine
  • func (w *WebappScaffold) GetPostgresPool() *pgxpool.Pool
  • func (w *WebappScaffold) PreInitDb() error
  • func (w *WebappScaffold) Shutdown() error
  • func (w *WebappScaffold) SyncStart() error
• type WebappScaffoldConfig

Variables

var ErrNotEnabled = errors.New("feature not enabled")

Functions

func ReadCustomConfig

func ReadCustomConfig(file string, s interface{}) error

Types

type GinApi

type GinApi interface {
	GetGin() *gin.Engine
}

type PostgresApi

type PostgresApi interface {
	GetPostgresPool() *pgxpool.Pool
}

type ScaffoldLifecycle

type ScaffoldLifecycle interface {
	SyncStart() error
	Shutdown() error
}

type WebappScaffold

type WebappScaffold struct {
	// contains filtered or unexported fields
}

func NewFromConfigFile

func NewFromConfigFile(file string) (*WebappScaffold, error)

func (*WebappScaffold) GetGin

func (w *WebappScaffold) GetGin() *gin.Engine

func (*WebappScaffold) GetPostgresPool

func (w *WebappScaffold) GetPostgresPool() *pgxpool.Pool

func (*WebappScaffold) PreInitDb

func (w *WebappScaffold) PreInitDb() error

func (*WebappScaffold) Shutdown

func (w *WebappScaffold) Shutdown() error

func (*WebappScaffold) SyncStart

func (w *WebappScaffold) SyncStart() error

type WebappScaffoldConfig

type WebappScaffoldConfig struct {
	GlobalConfig struct {
		Debug bool `toml:"debug"`
	} `toml:"global"`
	GinConfig struct {
		ReleaseMode       bool              `toml:"release_mode"`
		HtmlGlobPaths     []string          `toml:"html_glob_paths"`
		Listen            string            `toml:"listen" default:":6001"`
		StaticPathMapping map[string]string `toml:"static_path_mapping"`
	} `toml:"gin"`
	PgConfig struct {
		Enable                bool   `toml:"enable" default:"false"`
		PostgresConnectString string `toml:"connstring"`
	} `toml:"postgres"`
}