app

Documentation

Index

• type App
  • func New(configOptions ...ConfigOption) *App
  • func (app *App) RegisterRoutes(routes *routers.Routers)
• type ConfigOption
  • func WithConfiguration(config *config.Config) ConfigOption
  • func WithHTMLTemplateDir(htmlTemplateDir string) ConfigOption
  • func WithProxyURL(proxyPrefix string) ConfigOption
  • func WithStaticAssetDir(staticAssetDir string) ConfigOption

Types

type App

type App struct {
	Server   *fiber.App
	Config   *config.Config
	ProxyURL string
}

App struct consists of our application structure

func New

func New(configOptions ...ConfigOption) *App

New creates a new instance of App

func (*App) RegisterRoutes

func (app *App) RegisterRoutes(routes *routers.Routers)

RegisterRoutes registers all the routes associated with this application.

type ConfigOption

type ConfigOption struct {
	// contains filtered or unexported fields
}

ConfigOption will be a set of configuration options for APP

func WithConfiguration

func WithConfiguration(config *config.Config) ConfigOption

WithConfiguration will register a configuration of type *config.Config

func WithHTMLTemplateDir

func WithHTMLTemplateDir(htmlTemplateDir string) ConfigOption

WithHTMLTemplateDir will provide the base dir to load templates from pkger

func WithProxyURL

func WithProxyURL(proxyPrefix string) ConfigOption

WithProxyURL returns a proxy on wihch we will register our application This could look like "/production/prefix/stuff"

func WithStaticAssetDir

func WithStaticAssetDir(staticAssetDir string) ConfigOption

WithStaticAssetDir will provide the base dir to load static assets from pkger