README
¶
Scaffold
Scaffold is a Golang framework that includes everything needed to create database-backed API applications.
Requirements
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
- 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
- At the command prompt, create a new Scaffold application: (where
myappis the application name)
scaffold new myapp
- Change directory to
myappand start the web server:
cd myapp
make dev
-
Go to http://localhost:4000 and you'll see the Swagger documentation.
-
Under http://localhost:4000/index there is the default Index (controller/view) home page.
-
Follow the guidelines to start developing your application:
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 (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 (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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ContextAdapter ¶ added in v0.2.0
func ContextAdapter(handleFunc func(context *Context)) func(w http.ResponseWriter, r *http.Request)
Types ¶
type Context ¶ added in v0.2.0
type Context struct {
Request *http.Request
Response http.ResponseWriter
}
func NewContext ¶ added in v0.2.0
func NewContext(w http.ResponseWriter, r *http.Request) (context *Context)
func (*Context) RenderHTML ¶ added in v0.2.0
func (*Context) RenderText ¶ added in v0.2.0
func (*Context) UnmarshalBody ¶ added in v0.2.0
type Controller ¶ added in v0.2.0
type ResponseError ¶
type Router ¶ added in v0.2.0
func (*Router) Resource ¶ added in v0.2.0
func (r *Router) Resource(route string, controller Controller)
type Template ¶ added in v0.2.0
type Template struct {
ProjectName *helpers.Name
ResourceName *helpers.Name
ResourceFields map[*helpers.Name]string
Imports []string
}
func NewTemplate ¶ added in v0.2.0
func (*Template) CreateFile ¶ added in v0.2.0
func (*Template) CreateFiles ¶ added in v0.2.0
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.