app

Documentation

Index

• Variables
• func Bootstrap() error
• func RequiresBootStrap() bool
• func Setup(server *server.Server)
• func SetupAssets(server *server.Server)
• func SetupAuth(c Config)
• func SetupDatabase(server *server.Server)
• func SetupMail(server *server.Server)
• func SetupRoutes(r *router.Router)
• func SetupView(server *server.Server)
• type Config

Variables

var (
	// ConfigDevelopment holds the development config from fragmenta.json
	ConfigDevelopment map[string]string

	// ConfigProduction holds development config from fragmenta.json
	ConfigProduction map[string]string

	// ConfigTest holds the app test config from fragmenta.json
	ConfigTest map[string]string
)

Functions

func Bootstrap

func Bootstrap() error

Bootstrap generates missing config files, sql migrations, and runs the first migrations For this we need to know what to call the app, but we default to fragmenta-cms for now we could use our current folder name?

func RequiresBootStrap

func RequiresBootStrap() bool

RequiresBootStrap returns true if the app requires bootstrapping

func Setup

func Setup(server *server.Server)

Setup sets up our application.

func SetupAssets

func SetupAssets(server *server.Server)

SetupAssets compiles or copies our assets from src into the public assets folder.

func SetupAuth

func SetupAuth(c Config)

SetupAuth sets up the auth pkg and authorisation for users

func SetupDatabase

func SetupDatabase(server *server.Server)

SetupDatabase sets up the db with query given our server config.

func SetupMail

func SetupMail(server *server.Server)

SetupMail sets us up to send mail via sendgrid (requires key).

func SetupRoutes

func SetupRoutes(r *router.Router)

SetupRoutes adds routes for this app to this router.

func SetupView

func SetupView(server *server.Server)

SetupView sets up the view package by loadind templates.

Types

type Config

type Config interface {
	Production() bool
	Configuration() map[string]string
	Config(string) string
}

Config is used to pass settings to setup functions.