scaffold

README

Scaffold

Scaffold is a Golang framework that includes everything needed to create database-backed API applications.

Requirements

• make (Makefile)
• SQLite
• Go

Frameworks and libraries

Scaffold comes with:

• gorilla/mux, a powerful HTTP router and URL matcher for building Go web servers
• swaggo/swag, automatically generate RESTful API documentation with Swagger
• go-orm/gorm, the fantastic ORM library for Golang, aims to be developer friendly

Getting Started

1. Install Scaffold at the command prompt:

sudo curl -L "https://github.com/nanernunes/scaffold/releases/latest/download/scaffold-$(uname -s)-$(uname -m)" -o /usr/local/bin/scaffold
sudo chmod +x /usr/local/bin/scaffold

1. At the command prompt, create a new Scaffold application: (where myapp is the application name)

scaffold new myapp

1. Change directory to myapp and start the web server:

cd myapp
make dev

1. Go to http://localhost:4000 and you'll see the Swagger documentation.

2. Under http://localhost:4000/index there is the default Index (controller/view) home page.

3. Follow the guidelines to start developing your application:

   • Getting Started with Scaffold

Contributing

Contributions to Scaffold are welcome and appreciated. If you would like to contribute, please open an issue or submit a pull request.

License

Scaffold is licensed under the MIT License. See the LICENSE file for more information.

Documentation

Index

• func ContextAdapter(handleFunc func(context *Context)) func(w http.ResponseWriter, r *http.Request)
• type Context
  • func NewContext(w http.ResponseWriter, r *http.Request) (context *Context)
  • func (c *Context) Header(header string) string
  • func (c *Context) Headers() map[string]string
  • func (c *Context) Param(param string) (content string)
  • func (c *Context) Params() map[string]string
  • func (c *Context) Render(statusCode int, src interface{})
  • func (c *Context) RenderHTML(statusCode int, html string)
  • func (c *Context) RenderText(statusCode int, text string)
  • func (c *Context) UnmarshalBody(dest interface{}) error
  • func (c *Context) UseCORS()
• type Controller
• type ResponseError
• type Router
  • func NewRouter(router *mux.Router) *Router
  • func (r *Router) CONNECT(route string, callback func(context *Context))
  • func (r *Router) DELETE(route string, callback func(context *Context))
  • func (r *Router) GET(route string, callback func(context *Context))
  • func (r *Router) HEAD(route string, callback func(context *Context))
  • func (r *Router) OPTIONS(route string, callback func(context *Context))
  • func (r *Router) PATCH(route string, callback func(context *Context))
  • func (r *Router) POST(route string, callback func(context *Context))
  • func (r *Router) PUT(route string, callback func(context *Context))
  • func (r *Router) Resource(route string, controller Controller)
  • func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (r *Router) TRACE(route string, callback func(context *Context))
• type Template
  • func NewTemplate(project string) *Template
  • func (t *Template) AddMVC(name string, fields map[*helpers.Name]string)
  • func (t *Template) CreateFile(src string, dst string, any interface{})
  • func (t *Template) CreateFiles(files map[string]string)
  • func (t *Template) Skel()

Functions

func ContextAdapter

func ContextAdapter(handleFunc func(context *Context)) func(w http.ResponseWriter, r *http.Request)

Types

type Context

type Context struct {
	Request  *http.Request
	Response http.ResponseWriter
}

func NewContext

func NewContext(w http.ResponseWriter, r *http.Request) (context *Context)

func (*Context) Header

func (c *Context) Header(header string) string

func (*Context) Headers

func (c *Context) Headers() map[string]string

func (*Context) Param

func (c *Context) Param(param string) (content string)

func (*Context) Params

func (c *Context) Params() map[string]string

func (*Context) Render

func (c *Context) Render(statusCode int, src interface{})

func (*Context) RenderHTML

func (c *Context) RenderHTML(statusCode int, html string)

func (*Context) RenderText

func (c *Context) RenderText(statusCode int, text string)

func (*Context) UnmarshalBody

func (c *Context) UnmarshalBody(dest interface{}) error

func (*Context) UseCORS

func (c *Context) UseCORS()

type Controller

type Controller interface {
	Index(*Context)
	Show(*Context)
	Create(*Context)
	Update(*Context)
	Delete(*Context)
}

type ResponseError

type ResponseError struct {
	// Message with an error
	Error            string `json:"error"`
	ErrorDescription string `json:"error_description"`

} //	@name	Error

type Router

type Router struct {
	Internal *mux.Router
}

func NewRouter

func NewRouter(router *mux.Router) *Router

func (*Router) CONNECT

func (r *Router) CONNECT(route string, callback func(context *Context))

func (*Router) DELETE

func (r *Router) DELETE(route string, callback func(context *Context))

func (*Router) GET

func (r *Router) GET(route string, callback func(context *Context))

func (*Router) HEAD

func (r *Router) HEAD(route string, callback func(context *Context))

func (*Router) OPTIONS

func (r *Router) OPTIONS(route string, callback func(context *Context))

func (*Router) PATCH

func (r *Router) PATCH(route string, callback func(context *Context))

func (*Router) POST

func (r *Router) POST(route string, callback func(context *Context))

func (*Router) PUT

func (r *Router) PUT(route string, callback func(context *Context))

func (*Router) Resource

func (r *Router) Resource(route string, controller Controller)

func (*Router) ServeHTTP

func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Router) TRACE

func (r *Router) TRACE(route string, callback func(context *Context))

type Template

type Template struct {
	ProjectName    *helpers.Name
	ResourceName   *helpers.Name
	ResourceFields map[*helpers.Name]string
	Imports        []string
}

func NewTemplate

func NewTemplate(project string) *Template

func (*Template) AddMVC

func (t *Template) AddMVC(name string, fields map[*helpers.Name]string)

func (*Template) CreateFile

func (t *Template) CreateFile(src string, dst string, any interface{})

func (*Template) CreateFiles

func (t *Template) CreateFiles(files map[string]string)

func (*Template) Skel

func (t *Template) Skel()