framework

README

a modern web framework

Working on it...

TODO

• Authentication (component)
• Filesystem (component)
• Database (component, using gorm for now)
• CLI application

Documentation

Index

• Variables
• type App
  • func NewApp(configFs fs.FS) *App
  • func (app *App) Bootstrap() (*http.Server, error)
  • func (app *App) Configure(name string, value interface{}) *App
  • func (app *App) GetConfig() Config
  • func (app *App) Register(service Service) *App
  • func (app *App) Run(at string, register http.RouterRegister) error
• type Config
• type ConfigService
  • func (cs *ConfigService) Add(name string, config interface{}) *ConfigService
  • func (cs *ConfigService) Lifetime(container container.Interface, request contracts.RequestContract)
  • func (cs *ConfigService) Register(app *App) error
• type Service

Variables

var AppConfig = "app"

AppConfig: default app config name

var ConfigExt = ".yaml"

ConfigExt: default config extension

Types

type App

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

App: framework application

func NewApp

func NewApp(configFs fs.FS) *App

NewApp: new application instance

func (*App) Bootstrap

func (app *App) Bootstrap() (*http.Server, error)

Bootstrap application, will call before app run

func (*App) Configure

func (app *App) Configure(name string, value interface{}) *App

Configure: load config instance and add to config service

func (*App) GetConfig

func (app *App) GetConfig() Config

GetConfig: get app config instance

func (*App) Register

func (app *App) Register(service Service) *App

Register application service service

func (*App) Run

func (app *App) Run(at string, register http.RouterRegister) error

Run application service

type Config

type Config struct {
	Env   string `yaml:"env" env:"APP_ENV" default:"production"`
	Debug bool   `yaml:"debug" env:"APP_DEBUG" default:"false"`
}

Config of application

type ConfigService

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

ConfigService of application

func (*ConfigService) Add

func (cs *ConfigService) Add(name string, config interface{}) *ConfigService

Add config instance to service

func (*ConfigService) Lifetime

func (cs *ConfigService) Lifetime(container container.Interface, request contracts.RequestContract)

Lifetime container callback register config instance to request IoC-Container

func (*ConfigService) Register

func (cs *ConfigService) Register(app *App) error

Register config service when app starting

type Service

type Service interface {
	//Register service when app starting, before http server start
	// you can configure service, initialize global vars etc.
	// running at main goroutine
	Register(app *App) error

	//Lifetime container callback
	// usually register request lifetime instance to IoC-Container (per-request unique)
	// this function will run before every request
	Lifetime(ioc container.Interface, request contracts.RequestContract)
}