README
¶
Dawn
Dawn is an opinionated web framework that provides rapid development capabilities. It provides basic services such as logging, configuration, fiber extension, gorm extension, and event system.
The core idea of Dawn is modularity. High-level business modules can invoke low-level modules, such as databases and so on.
Each module needs to implement its own two core methods of Init and Boot, and then register it in Sloop. General business modules need to implement its Register Routes method to register routes and provide http services.
The modules should be based on the principle of not recreating the wheel, and directly provides the original structure and method of the dependent library.
The libraries currently used are
Notice
This project is still under development, please do not use it in a production environment.
Why dawn?
Tribute to the first episode of one piece romance dawn. Let us set sail towards romance with the sloop.
Documentation
¶
Index ¶
- Constants
- type Cleanup
- type Config
- type Module
- type Moduler
- type Sloop
- func (s *Sloop) AddModulers(m ...Moduler) *Sloop
- func (s *Sloop) Cleanup()
- func (s *Sloop) Router() fiber.Router
- func (s *Sloop) Run(addr string) error
- func (s *Sloop) RunTls(addr, certFile, keyFile string) error
- func (s *Sloop) Setup() *Sloop
- func (s *Sloop) Shutdown() error
- func (s *Sloop) Watch()
Constants ¶
const Version = "0.4.0"
Version of current dawn package
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// App indicates to fiber app instance
App *fiber.App
}
Config is a struct holding the sloop settings.
type Module ¶
type Module struct{}
Module is an empty struct implements Moduler interface and can be embedded into custom struct as a Moduler
func (Module) RegisterRoutes ¶
func (Module) RegisterRoutes(fiber.Router)
RegisterRoutes add routes to fiber router
type Moduler ¶
type Moduler interface {
// Stringer indicates module's name
fmt.Stringer
// Init does initialization works and should return
// a cleanup function.
Init() Cleanup
// Boot boots the module.
Boot()
// RegisterRoutes add routes to fiber router
RegisterRoutes(fiber.Router)
}
Moduler is the interface that wraps the module's method.
type Sloop ¶
type Sloop struct {
// Config is the embedded config
Config
// contains filtered or unexported fields
}
Sloop denotes Dawn application
func Default ¶
func Default(cfg ...fiber.Config) *Sloop
Default returns an Sloop instance with the `RequestID`, `Logger`, `Recovery`, `Pprof` middleware already attached in default fiber app.
func (*Sloop) AddModulers ¶
AddModulers appends more Modulers
Source Files
Directories