golive

README

golive

golive is a webserver support package for you go (golang) web application.

It is based on gofiber and gorm.

It provides helpers for:

• minio/s3
• imageproxy
• redis
• csrf protection
• environment variables (configuration)
• logging (zerolog)
• database (gorm)
• webserver / router (gofiber)
• search (typesense)

Usage

go get -u github.com/jesko-plitt/golive

TODOs

• write readme
• write simple usage manual
• write code comments
• write tests

Documentation

Index

• func InitializeDatabase(log2 logging.Logger) *storage.Controller
• func InitializeLogger() logging.Logger
• func ProvideDatabaseFromServer(srv *Server) *storage.Controller
• func ProvideLoggerFromServer(srv *Server) logging.Logger
• func ProvideShutdownFromServer(srv *Server) *server.ShutdownService
• type Container
• type Registry
  • func Init() *Registry
  • func (r *Registry) DB() *storage.Controller
  • func (r *Registry) GetRouter() *fiber.App
  • func (r *Registry) GetServer() *Server
  • func (r *Registry) Log() logging.Logger
• type Server
  • func InitializeServer() *Server
  • func (s *Server) DB() *storage.Controller
  • func (s *Server) Logger() logging.Logger
  • func (s *Server) Router() *fiber.App
  • func (s *Server) Serve()
  • func (s *Server) Shutdown() *server.ShutdownService

Functions

func InitializeDatabase

func InitializeDatabase(log2 logging.Logger) *storage.Controller

func InitializeLogger

func InitializeLogger() logging.Logger

func ProvideDatabaseFromServer

func ProvideDatabaseFromServer(srv *Server) *storage.Controller

func ProvideLoggerFromServer

func ProvideLoggerFromServer(srv *Server) logging.Logger

func ProvideShutdownFromServer

func ProvideShutdownFromServer(srv *Server) *server.ShutdownService

Types

type Container

type Container interface {
	Log() logging.Logger
	DB() *storage.Controller
	GetServer() *Server
	GetRouter() *fiber.App
}

type Registry

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

func Init

func Init() *Registry

func (*Registry) DB

func (r *Registry) DB() *storage.Controller

func (*Registry) GetRouter

func (r *Registry) GetRouter() *fiber.App

func (*Registry) GetServer

func (r *Registry) GetServer() *Server

func (*Registry) Log

func (r *Registry) Log() logging.Logger

type Server

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

func InitializeServer

func InitializeServer() *Server

func (*Server) DB

func (s *Server) DB() *storage.Controller

func (*Server) Logger

func (s *Server) Logger() logging.Logger

func (*Server) Router

func (s *Server) Router() *fiber.App

func (*Server) Serve

func (s *Server) Serve()

func (*Server) Shutdown

func (s *Server) Shutdown() *server.ShutdownService