calypso

README

Calypso

Its is an Base Module for any airstrik application to bootstrap the application with all the security aspect

To handle pull requests

• fork a repository github.com/workfoxes/calypso to github.com/you/calypso
• download original code: go get github.com/workfoxes/calypso
• be there: cd "$(go env GOPATH)/src"/github.com/workfoxes/calypso
• enable uploading to your fork: git remote add myfork https://github.com/you/calypso.git
• upload your changes to your repo: git push myfork

Documentation

Index

• func DefaultProviders(app *ApplicationServer)
• func InitDatabaseConnection()
• type ApplicationConfig
• type ApplicationServer
  • func CreateAppServer(Name string, Port int) *ApplicationServer
  • func New(config *ApplicationConfig) *ApplicationServer
  • func (app *ApplicationServer) AddProvider(constructor interface{}, opts ...dig.ProvideOption)
  • func (app *ApplicationServer) Invoker(function interface{}, opts ...dig.ProvideOption)
  • func (app *ApplicationServer) LoadDefaultMiddleware()
  • func (app *ApplicationServer) Start()
  • func (app *ApplicationServer) Use(args ...interface{})

Functions

func DefaultProviders

func DefaultProviders(app *ApplicationServer)

DefaultProviders : will provide all the default provider in the server start

func InitDatabaseConnection

func InitDatabaseConnection()

InitDatabaseConnection : init the database connection

Types

type ApplicationConfig

type ApplicationConfig struct {
	Name string
	Port int
}

type ApplicationServer

type ApplicationServer struct {
	Server *fiber.App
	Name   string
	Port   int
	// contains filtered or unexported fields
}

ApplicationServer : Application server will hold the service object for the application

func CreateAppServer

func CreateAppServer(Name string, Port int) *ApplicationServer

CreateAppServer : func to create Application server object to Manage the application server

func New

func New(config *ApplicationConfig) *ApplicationServer

New : Will create New Server the Need as default for the Workfoxes Application

Also will add all the default provider to this server

func (*ApplicationServer) AddProvider

func (app *ApplicationServer) AddProvider(constructor interface{}, opts ...dig.ProvideOption)

AddProvider : This will add new provider to the server container

func (*ApplicationServer) Invoker

func (app *ApplicationServer) Invoker(function interface{}, opts ...dig.ProvideOption)

Invoker : This will add new provider to the server container

func (*ApplicationServer) LoadDefaultMiddleware

func (app *ApplicationServer) LoadDefaultMiddleware()

LoadDefaultMiddleware : this function will load all the middleware that are need for application

func (*ApplicationServer) Start

func (app *ApplicationServer) Start()

Start : Will Start the Application service for the Thermite

func (*ApplicationServer) Use

func (app *ApplicationServer) Use(args ...interface{})

Use : This function will allow us to add the middleware into the web application