kaiju

README

Kaiju

Kaiju is a web application framework for the Go programming language. It brings together the standard Go libraries and a number of third party libraries in a sane way, providing developers with a single, easy-to-use web app framework.

Kaiju makes use of the following third party libraries:

• Gorrilla Mux for muxing HTTP(S) requests.
• Seelog for logging all the things.
• And more to come!

For more information on using Kaiju, checkout out our wiki!

Want to contribute to Kaiju?

Before working on the code, if you plan to contribute changes, please read the following CONTRIBUTING document.

Need help or found an issue?

When reporting an issue through the issue tracker on GitHub, please use the following guidelines:

• Check existing issues to see if it has been addressed already
• The version of Kaiju you are using
• A short description of the issue you are experiencing and the expected outcome
• Description of how someone else can reproduce the problem
• Paste error output or logs in your issue or in a Gist. If pasting them in the GitHub issue, wrap it in three backticks: ``` so that it renders nicely
• Write a unit test to show the issue!

Documentation

Index

• Variables
• func AddShutdownHook(f func())
• func RegisterControlCFunction()
• func Start(config Config) error
• type Config

Variables

var (
	Muxer *mux.Router = mux.NewRouter()
)

Functions

func AddShutdownHook

func AddShutdownHook(f func())

AddShutdownHook appends a function to the list of functions that will be executed before the application shuts down. Note that these hooks will not be executed in the event of a panic.

func RegisterControlCFunction

func RegisterControlCFunction()

Registers a signal handler to kill the app if Ctrl-C is pressed.

func Start

func Start(config Config) error

Starts Kaiju using a kaiju/http.SimpleHttpServer with the provided config. An error is returned it kaiju fails to start.

Types

type Config

type Config struct {
	Http    http.Config
	Logging logging.Config
}