caveman

README

Basic things to implement

• Merge dafault routes and assets directory with the main one

Documentation

Index

• func RunMigrations(app app.App) error
• type Caveman
  • func New() *Caveman
  • func NewWithSettings(settings models.Config) *Caveman
  • func (cm *Caveman) Execute() error
  • func (cm *Caveman) Start() error

Functions

func RunMigrations

func RunMigrations(app app.App) error

Types

type Caveman

type Caveman struct {
	*app.App

	RootCmd         *cobra.Command
	StartupSettings models.Config
}

Caveman defines a Caveman apppplication It embeds the App methods (providing all kinds of low-level access) But here are some higher-level methods given for convenience. Also, the user can give a custom settings struct to run the app with, that optionally can be saved as the most recent settings into the DB.

func New

func New() *Caveman

Creates a new Caveman instance with either the - latest settings from the DB - or the default settings if no settings are found.

func NewWithSettings

func NewWithSettings(settings models.Config) *Caveman

NewWithSettings creates a new Caveman instance with the provided config.

Note that the application will not be initialized/bootstrapped yet, aka. DB connections, migrations, app settings, etc. will not be accessible. Everything will be initialized when [Start()] is executed. If you want to initialize the application before calling [Start()], then you'll have to manually call [Bootstrap()].

func (*Caveman) Execute

func (cm *Caveman) Execute() error

func (*Caveman) Start

func (cm *Caveman) Start() error

Start starts the application, aka. registers the default system commands (serve, migrate, version) and executes cm.RootCmd.