zepto

README

Go-Zepto

Zepto is a lightweight web framework written in go.

Documentation

Official Documentation

---

Quickstart

Install the Go-Zepto CLI:

$ go get -u github.com/go-zepto/zepto-cli/cmd/zepto

---

Create a Project

$ zepto new github.com/username/project

Start development server

$ cd project
$ zepto dev

Great! You brand new project should be running at http://localhost:8000

Documentation

Index

• func NewLoggingResponseWriter(w http.ResponseWriter) *loggingResponseWriter
• type HTTPZeptoHandler
  • func (h *HTTPZeptoHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HealthHandler
• type HealthStatus
• type Option
  • func HTTPServer(s *http.Server) Option
  • func Logger(l logger.Logger) Option
  • func Name(n string) Option
  • func SessionName(name string) Option
  • func SessionStore(store sessions.Store) Option
  • func TemplateEngine(tmplEngine renderer.Engine) Option
  • func Version(v string) Option
  • func WebpackEnabled(enabled bool) Option
• type Options
• type Plugin
• type Zepto
  • func NewZepto(configs ...config.Config) *Zepto
  • func (z *Zepto) AddPlugin(plugin Plugin)
  • func (z *Zepto) DB() *gorm.DB
  • func (z *Zepto) InitApp()
  • func (z *Zepto) Logger() logger.Logger
  • func (z *Zepto) Plugins() map[string]Plugin
  • func (z *Zepto) SetupGRPC(addr string, fn func(s *grpc.Server))
  • func (z *Zepto) Start()

Functions

func NewLoggingResponseWriter

func NewLoggingResponseWriter(w http.ResponseWriter) *loggingResponseWriter

Types

type HTTPZeptoHandler

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

func (*HTTPZeptoHandler) ServeHTTP

func (h *HTTPZeptoHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type HealthHandler

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

type HealthStatus

type HealthStatus struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	Age     string `json:"age"`
}

type Option

type Option func(*Options)

func HTTPServer

func HTTPServer(s *http.Server) Option

HTTPServer - Use a custom HTTP Server

func Logger

func Logger(l logger.Logger) Option

Logger is the mains logger used in all zepto app

func Name

func Name(n string) Option

Zepto App Name

func SessionName

func SessionName(name string) Option

SessionName - Set the session name

func SessionStore

func SessionStore(store sessions.Store) Option

SessionStore - Set the session name

func TemplateEngine

func TemplateEngine(tmplEngine renderer.Engine) Option

TemplateEngine - Change the template engine implementation

func Version

func Version(v string) Option

Name of Zepto App

func WebpackEnabled

func WebpackEnabled(enabled bool) Option

type Options

type Options struct {
	Name           string
	Version        string
	Env            string
	Logger         logger.Logger
	WebpackEnabled bool
	TmplEngine     renderer.Engine
	SessionName    string
	SessionSecret  string
	SessionStore   sessions.Store
	// Custom HTTP server
	HTTPServer *http.Server
}

type Plugin

type Plugin interface {
	Name() string
	Instance() interface{}
	PrependMiddlewares() []web.MiddlewareFunc
	AppendMiddlewares() []web.MiddlewareFunc
	OnCreated(z *Zepto)
	OnZeptoInit(z *Zepto)
	OnZeptoStart(z *Zepto)
	OnZeptoStop(z *Zepto)
}

type Zepto

type Zepto struct {
	*web.App
	// contains filtered or unexported fields
}

func NewZepto

func NewZepto(configs ...config.Config) *Zepto

func (*Zepto) AddPlugin

func (z *Zepto) AddPlugin(plugin Plugin)

func (*Zepto) DB

func (z *Zepto) DB() *gorm.DB

func (*Zepto) InitApp

func (z *Zepto) InitApp()

func (*Zepto) Logger

func (z *Zepto) Logger() logger.Logger

func (*Zepto) Plugins

func (z *Zepto) Plugins() map[string]Plugin

func (*Zepto) SetupGRPC

func (z *Zepto) SetupGRPC(addr string, fn func(s *grpc.Server))

func (*Zepto) Start

func (z *Zepto) Start()