mirror of
https://github.com/retailcrm/mg-transport-core.git
synced 2024-11-29 00:25:31 +03:00
Neur0toxine
54326b4193
* endpoint fields for aws config * fix for linter * fix for demo in the readme
147 lines
4.8 KiB
Markdown
147 lines
4.8 KiB
Markdown
## Message Gateway Transport Library
|
|
[](https://github.com/retailcrm/mg-transport-core/actions?query=workflow%3Aci)
|
|
[](https://codecov.io/gh/retailcrm/mg-transport-core)
|
|
[](https://github.com/retailcrm/mg-transport-core/releases)
|
|
[](https://goreportcard.com/report/github.com/retailcrm/mg-transport-core)
|
|
[](https://golang.org/dl/)
|
|
[](https://pkg.go.dev/github.com/retailcrm/mg-transport-core/core)
|
|
|
|
This library provides different functions like error-reporting, logging, localization, etc. in order to make it easier to create transports.
|
|
|
|
Usage:
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"os"
|
|
"fmt"
|
|
"html/template"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/retailcrm/mg-transport-core/core"
|
|
)
|
|
|
|
func main() {
|
|
// Create new core.Engine instance
|
|
app := core.New(core.AppInfo{
|
|
Version: "v1.0",
|
|
Commit: "bcef82e",
|
|
Build: "v1.0-bcef82e",
|
|
BuildDate: "1649766442",
|
|
})
|
|
|
|
// Load configuration
|
|
app.Config = core.NewConfig("config.yml")
|
|
|
|
// Set default error translation key (will be returned if something goes wrong)
|
|
app.DefaultError = "unknown_error"
|
|
|
|
// Set translations path
|
|
app.TranslationsPath = "./translations"
|
|
|
|
// Preload some translations so they will not be loaded for every request
|
|
app.PreloadLanguages = core.DefaultLanguages
|
|
|
|
// Configure gin.Engine inside core.Engine
|
|
app.ConfigureRouter(func(engine *gin.Engine) {
|
|
engine.Static("/static", "./static")
|
|
engine.HTMLRender = app.CreateRenderer(
|
|
] // Insert templates here. Custom functions also can be provided.
|
|
// Default transl function will be injected automatically
|
|
func(renderer *core.Renderer) {
|
|
// Push method will load template from FS or from binary
|
|
r.Push("home", "templates/layout.html", "templates/home.html")
|
|
},
|
|
template.FuncMap{},
|
|
)
|
|
})
|
|
|
|
// Start application or fail if something gone wrong (e.g. port is already in use)
|
|
if err := app.Prepare().Run(); err != nil {
|
|
fmt.Printf("Fatal error: %s", err.Error())
|
|
os.Exit(1)
|
|
}
|
|
}
|
|
```
|
|
|
|
### Resource embedding
|
|
[embed](https://golang.org/pkg/embed/) can be used to provide resource embedding. Go source files that import "embed" can use the //go:embed directive to initialize a variable of type string, []byte, or FS with the contents of files read from the package directory or subdirectories at compile time.
|
|
|
|
Example:
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"os"
|
|
"fmt"
|
|
"html/template"
|
|
"io/fs"
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/retailcrm/mg-transport-core/core"
|
|
)
|
|
|
|
//go:embed static
|
|
var Static fs.FS
|
|
|
|
//go:embed translations
|
|
var Translate fs.FS
|
|
|
|
//go:embed templates
|
|
var Templates fs.FS
|
|
|
|
func main() {
|
|
staticFS, err := fs.Sub(Static, "static")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
translateFS, err := fs.Sub(Translate, "translate")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
templatesFS, err := fs.Sub(Templates, "templates")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
app := core.New()
|
|
app.Config = core.NewConfig("config.yml")
|
|
app.DefaultError = "unknown_error"
|
|
|
|
// Now translations will be loaded from embedded files in Go program
|
|
app.TranslationsFS = translateFS
|
|
app.PreloadLanguages = core.DefaultLanguages
|
|
|
|
app.ConfigureRouter(func(engine *gin.Engine) {
|
|
// fs.FS should be converted to the http.FileSystem
|
|
|
|
// FS implements the io/fs package's FS interface,
|
|
// so it can be used with any package that understands file systems,
|
|
// including net/http, text/template, and html/template.
|
|
engine.StaticFS("/static", http.FS(staticFS))
|
|
engine.HTMLRender = app.CreateRendererFS(
|
|
templatesFS,
|
|
func(renderer *core.Renderer) {
|
|
// Same Push method here, but without relative directory.
|
|
r.Push("home", "layout.html", "home.html")
|
|
},
|
|
template.FuncMap{},
|
|
)
|
|
})
|
|
|
|
if err := app.Prepare().Run(); err != nil {
|
|
fmt.Printf("Fatal error: %s", err.Error())
|
|
os.Exit(1)
|
|
}
|
|
}
|
|
```
|
|
### Migration generator
|
|
This library contains helper tool for transports. You can install it via go:
|
|
```sh
|
|
$ go get -u github.com/retailcrm/mg-transport-core/cmd/transport-core-tool
|
|
```
|
|
Currently, it only can generate new migrations for your transport.
|