README
¶
Gowok is a library that contains a lot of functions that help you to build Go project.
It has some utilities like:
- config loader,
- project bootstrapper,
- HTTP response builder,
- nil safety,
- password hash, and so on.
Getting Started
Installation
Run this command inside your project.
go get github.com/gowok/gowok
Import in Project
In your main.go, write code like following example:
package main
import "github.com/gowok/gowok"
func main() {
gowok.Run()
}
Create Configuration
- Create a YAML file named
config.yaml. - Then write this.
web:
enabled: true
host: :8080
Running the Project
Run this command inside your project.
go run main.go
Or if config file not on root dir, use flag --config
go run main.go --config=folder/gowok.yaml
It will show output like this:
2025/01/13 10:43:09 INFO starting web
Your project now ready to use 🔥
Let's try to send a request using curl!
curl localhost:8080
It will show output like this:
404 page not found
It means that your project already run. It can receive actual request and give response to it.
Apply Plugin
gowok have multiple plugin to help you to build your project, please check here for available plugins.
How to use plugin
example we want to use gorm
we can import plugin gorm
import "github.com/gowok/plugins/gorm"
after import plugin, we can configure it to main function or function you want to open database connection
func main() {
gowok.Configures(
gorm.Configure(map[string]gorm.Opener{
"postgres": driver.Open,
}),
)
}
then you can use gorm example like this:
db, _ := gorm.DB("postgres").Get()
db.WithContext(ctx).First(&user)
How to Contribute
Feel free to raise an issue or lovely pull request 😊
Documentation
¶
Index ¶
- Variables
- func DD(input any) error
- func Flags() *flags
- func HttpAccepted(rw http.ResponseWriter, body any)
- func HttpBadRequest(rw http.ResponseWriter, body any)
- func HttpConflict(rw http.ResponseWriter, body any)
- func HttpCreated(rw http.ResponseWriter, body any)
- func HttpForbidden(rw http.ResponseWriter)
- func HttpInternalServerError(rw http.ResponseWriter, body any)
- func HttpNoContent(rw http.ResponseWriter)
- func HttpNotFound(rw http.ResponseWriter)
- func HttpOk(rw http.ResponseWriter, body any)
- func HttpUnauthorized(rw http.ResponseWriter)
- func Must[T any](res T, err error) T
- func Run(config ...any)
- func Shutdown()
- func ToPtr[T any](v T) *T
- type ConfigureFunc
- type Password
- type Project
Constants ¶
This section is empty.
Variables ¶
var Async = &_async{}
var CMD = &_cmd{ Command: &cobra.Command{}, }
var Config = &config.Config{}
var Hash = _hash{}
var Health = _health{ // contains filtered or unexported fields }
var Hooks = &_hooks{&runtime.Hooks{}}
var Net = &_net{ handler: func(l net.Conn) {}, }
var SQL = _sql{ // contains filtered or unexported fields }
var Web = &_web{ HttpServeMux: ngamux.NewHttpServeMux(), Server: &http.Server{}, Handler: &_webHandler{}, Response: &_webResponse{}, Request: &_webRequest{}, Resource: &_webResource{}, }
Functions ¶
func HttpAccepted ¶
func HttpAccepted(rw http.ResponseWriter, body any)
func HttpBadRequest ¶
func HttpBadRequest(rw http.ResponseWriter, body any)
func HttpConflict ¶
func HttpConflict(rw http.ResponseWriter, body any)
func HttpCreated ¶
func HttpCreated(rw http.ResponseWriter, body any)
func HttpForbidden ¶
func HttpForbidden(rw http.ResponseWriter)
func HttpInternalServerError ¶
func HttpInternalServerError(rw http.ResponseWriter, body any)
func HttpNoContent ¶
func HttpNoContent(rw http.ResponseWriter)
func HttpNotFound ¶
func HttpNotFound(rw http.ResponseWriter)
func HttpOk ¶
func HttpOk(rw http.ResponseWriter, body any)
func HttpUnauthorized ¶
func HttpUnauthorized(rw http.ResponseWriter)
Types ¶
type ConfigureFunc ¶
type ConfigureFunc func()
type Project ¶
type Project struct {
// contains filtered or unexported fields
}
func Configures ¶ added in v0.3.94
func Configures(configures ...ConfigureFunc) *Project
Source Files
Directories