mirror of
https://github.com/retailcrm/mg-transport-core.git
synced 2024-11-29 00:25:31 +03:00
Neur0toxine
52109ee4ba
* new error collector & improvements for errors * update golangci-lint, microoptimizations, linter fixes * UseTLS10 method * remove dead code * add 1.17 to the test matrix * fix for docstring * split the core package symbols into the subpackages (if feasible)
116 lines
2.9 KiB
Go
116 lines
2.9 KiB
Go
/*
|
|
Package core provides different functions like error-reporting, logging, localization, etc.
|
|
to make it easier to create transports.
|
|
Usage:
|
|
package main
|
|
|
|
import (
|
|
"os"
|
|
"fmt"
|
|
"html/template"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/retailcrm/mg-transport-core/core"
|
|
)
|
|
|
|
func main() {
|
|
app := core.New()
|
|
app.Config = core.NewConfig("config.yml")
|
|
app.DefaultError = "unknown_error"
|
|
app.TranslationsPath = "./translations"
|
|
|
|
app.ConfigureRouter(func(engine *gin.Engine) {
|
|
engine.Static("/static", "./static")
|
|
engine.HTMLRender = app.CreateRenderer(
|
|
func(renderer *core.Renderer) {
|
|
// insert templates here. Example:
|
|
r.Push("home", "templates/layout.html", "templates/home.html")
|
|
},
|
|
template.FuncMap{},
|
|
)
|
|
})
|
|
|
|
if err := app.Prepare().Run(); err != nil {
|
|
fmt.Printf("Fatal error: %s", err.Error())
|
|
os.Exit(1)
|
|
}
|
|
}
|
|
|
|
Resource embedding
|
|
|
|
packr can be used to provide resource embedding, see:
|
|
https://github.com/gobuffalo/packr/tree/master/v2
|
|
In order to use packr you must follow instruction, and provide boxes with templates, translations and assets to library.
|
|
You can find instruction here:
|
|
https://github.com/gobuffalo/packr/tree/master/v2#library-installation
|
|
Example of usage:
|
|
package main
|
|
|
|
import (
|
|
"os"
|
|
"fmt"
|
|
"html/template"
|
|
"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"
|
|
app.TranslationsFS = translateFS
|
|
|
|
app.ConfigureRouter(func(engine *gin.Engine) {
|
|
engine.StaticFS("/static", http.FS(staticFS))
|
|
engine.HTMLRender = app.CreateRendererFS(
|
|
templatesFS,
|
|
func(renderer *core.Renderer) {
|
|
// insert templates here. Example:
|
|
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:
|
|
$ go get -u github.com/retailcrm/mg-transport-core/cmd/transport-core-tool
|
|
Currently, it only can generate new migrations for your transport.
|
|
|
|
Copyright (c) 2019 RetailDriver LLC. Usage of this source code is governed by a MIT license.
|
|
*/
|
|
package core
|