web

package

v0.0.0-...-783bbf4 Latest Latest Go to latest Published: Nov 24, 2015 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package web provides an HTTP server for the dashboard application

This section is empty.

This section is empty.

func Getenv(envVarName string, defaultValue string) string

Getenv returns the value of the env var with the given name, or fallback to the given default value.

func RunHttpServer()

RunHttpServer runs an HTTP server on a port defined by the PORT env var (default to 8080)

type Context struct {
	ClientWrapper *api.ClientWrapper
	Render        *render.Render
	Stats         *stats.Stats
}

Context is a web context used to answer to requests.

func NewContext() *Context

NewContext builds a new Context instance

func (c *Context) HomeHandler(w http.ResponseWriter, req *http.Request, _ httprouter.Params)

HomeHandler answers HTTP requests by loading data for all resource types and using the "home" view

func (c *Context) StatsHandler(w http.ResponseWriter, req *http.Request, _ httprouter.Params)

StatsHandler answers HTTP requests with the stats in JSON format

type Data struct {
	*api.Data
}

Data represents the data retrieved from the API, and exposed to view

func (d *Data) Title() string

Title returns the title of the page using either the env var DASHBOARD_TITLE or a default title.