nako

README

Nako

A lightweight go web framework.

Skeleton Repo

• see inhere/go-web-skeleton

Create Project

go get github.com/gookit/nako/cmd/nako

// create new project
nako new:app my-project ./

Flow

Start boot

LICENSE

MIT

Documentation

Index

• Constants
• Variables
• func Cache() cache.Cache
• func Config() *config.Config
• func Redis()
• func Router() *rux.Router
• func SetDefaultApp(app *Application)
• func SetMode(name mode)
• type Application
  • func App() *Application
  • func DefaultApp() *Application
  • func NewApp() *Application
  • func (a *Application) Get(name string) interface{}
  • func (a *Application) Run()
  • func (a *Application) Set(name string, val interface{})
• type BootFunc
  • func (fn BootFunc) Boot(app *Application) error
• type BootLoader

Constants

const (
	OnBeforeBoot = "app.boot.before"
	OnAfterBoot  = "app.boot.after"

	OnBeforeConfig = "app.config.before"
	OnAfterConfig  = "app.config.after"

	OnBeforeConsole = "app.console.before"
	OnAfterConsole  = "app.console.after"

	OnBeforeRoute = "app.route.before"
	OnAfterRoute  = "app.route.after"
)

Some app event names

const (
	ModeDev  mode = "dev"
	ModeTest mode = "test"
	ModeProd mode = "prod"
)

Variables

var (
	Debug = false
	Mode  = ModeDev
)

Functions

func Cache

func Cache() cache.Cache

Cache get

func Config

func Config() *config.Config

Router get

func Redis

func Redis()

func Router

func Router() *rux.Router

Router get from global app

func SetDefaultApp

func SetDefaultApp(app *Application)

SetGlobal app instance

func SetMode

func SetMode(name mode)

SetMode set run mode

Types

type Application

type Application struct {
	*event.Manager

	Name string

	BootLoaders []BootLoader

	// components
	View   *view.Renderer
	Cache  cache.Cache
	Config *config.Config
	Router *rux.Router
	Logger *slog.Logger
	// contains filtered or unexported fields
}

Application instance

func App

func App() *Application

App get application instance

func DefaultApp

func DefaultApp() *Application

DefaultApp get application instance

func NewApp

func NewApp() *Application

NewApp new application instance

func (*Application) Get

func (a *Application) Get(name string) interface{}

Get component from app.components

func (*Application) Run

func (a *Application) Run()

Run the application Usage:

app.Run()

func (*Application) Set

func (a *Application) Set(name string, val interface{})

Set component to app.components

type BootFunc

type BootFunc func(app *Application) error

BootFunc for application

func (BootFunc) Boot

func (fn BootFunc) Boot(app *Application) error

Boot do something

type BootLoader

type BootLoader interface {
	// Boot do something before application run
	Boot(app *Application) error
}

BootLoader for app start boot