goal

README

Goal

Goal is a lightweight web framework like Django written in Golang.

GoalGenerator can auto-generate golang models from yaml file.

GoalUI is front of Goal.

Install Goal

• Go 1.20+

• Repository

$ git clone git@github.com:huoyijie/Goal.git

• Tidy

$ cd Goal
$ go mod tidy

Run example

• Create Superuser

$ cd Goal
$ go run ./goalcli -email huoyijie@huoyijie.cn -username huoyijie

• Default Database (sqlite)

$ ls -l ~/.goal/goal.db

• Run example goal-web

$ cd Goal/examples
$ go run goal-web.go

Install GoalGenerator

• Repository

$ go install github.com/huoyijie/GoalGenerator/goalgen@v0.0.29

• Generate models from yaml files

$ cd Goal
$ goalgen -d yamls

Documentation

Index

• type Config
• type Cookie
• type Goal
  • func New(config Config, db *gorm.DB, models ...any) Goal

Types

type Config

type Config struct {
	AllowOrigins, TrustedProxies []string
	Cookie
}

type Cookie

type Cookie struct {
	Domain string
	Secure bool
}

type Goal

type Goal interface {
	CreateSuper(*auth.User)
	Router() *gin.Engine
}

func New

func New(config Config, db *gorm.DB, models ...any) Goal