104 lines
5.6 KiB
Markdown
104 lines
5.6 KiB
Markdown
Tango [](https://drone.io/github.com/lunny/tango/latest) [](http://gocover.io/github.com/lunny/tango) [简体中文](README_CN.md)
|
|
=======================
|
|
|
|
|
|
|
|
Package tango is a micro-kernel & pluggable web framework for Go.
|
|
|
|
##### Current version: v0.3.0 [Version History](https://github.com/lunny/tango/releases)
|
|
|
|
## Getting Started
|
|
|
|
To install Tango:
|
|
|
|
go get github.com/lunny/tango
|
|
|
|
A classic usage of Tango below:
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"errors"
|
|
|
|
"github.com/lunny/tango"
|
|
)
|
|
|
|
type Action struct {
|
|
tango.Json
|
|
}
|
|
|
|
func (Action) Get() interface{} {
|
|
if true {
|
|
return map[string]string{
|
|
"say": "Hello tango!",
|
|
}
|
|
}
|
|
return errors.New("something error")
|
|
}
|
|
|
|
func main() {
|
|
t := tango.Classic()
|
|
t.Get("/", new(Action))
|
|
t.Run()
|
|
}
|
|
```
|
|
|
|
Then visit `http://localhost:8000` on your browser. You will get
|
|
```
|
|
{"say":"Hello tango!"}
|
|
```
|
|
|
|
If you change `true` after `if` to `false`, then you will get
|
|
```
|
|
{"err":"something error"}
|
|
```
|
|
|
|
This code will automatically convert returned map or error to a json because we has an embedded struct `tango.Json`.
|
|
|
|
More document, please see [godoc](http://godoc.org/github.com/lunny/tango) and [Wiki](https://github.com/lunny/tango/wiki)
|
|
|
|
## Features
|
|
|
|
- Powerful routing & Flexible routes combinations.
|
|
- Directly integrate with existing services.
|
|
- Easy to plugin/unplugin features with modular design.
|
|
- High performance dependency injection embedded.
|
|
|
|
## Middlewares
|
|
|
|
Middlewares allow you easily plugin/unplugin features for your Tango applications.
|
|
|
|
There are already many [middlewares](https://github.com/tango-contrib) to simplify your work:
|
|
|
|
- recovery - recover after panic
|
|
- compress - Gzip & Deflate compression
|
|
- static - Serves static files
|
|
- logger - Log the request & inject Logger to action struct
|
|
- param - get the router parameters
|
|
- return - Handle the returned value smartlly
|
|
- context - Inject context to action struct
|
|
- [session](https://github.com/tango-contrib/session) - [](https://drone.io/github.com/tango-contrib/session/latest) [](http://gocover.io/github.com/tango-contrib/session) Session manager
|
|
- [xsrf](https://github.com/tango-contrib/xsrf) - [](https://drone.io/github.com/tango-contrib/xsrf/latest) [](http://gocover.io/github.com/tango-contrib/xsrf) Generates and validates csrf tokens
|
|
- [binding](https://github.com/tango-contrib/binding) - [](https://drone.io/github.com/tango-contrib/binding/latest) [](http://gocover.io/github.com/tango-contrib/binding) Bind and validates forms
|
|
- [renders](https://github.com/tango-contrib/renders) - [](https://drone.io/github.com/tango-contrib/renders/latest) [](http://gocover.io/github.com/tango-contrib/renders) Go template engine
|
|
- [dispatch](https://github.com/tango-contrib/dispatch) - [](https://drone.io/github.com/tango-contrib/dispatch/latest) [](http://gocover.io/github.com/tango-contrib/dispatch) Multiple Application support on one server
|
|
- [tpongo2](https://github.com/tango-contrib/tpongo2) - [](https://drone.io/github.com/tango-contrib/tpongo2/latest) [](http://gocover.io/github.com/tango-contrib/tpongo2) [Pongo2](https://github.com/flosch/pongo2) teamplte engine support
|
|
- [captcha](https://github.com/tango-contrib/captcha) - [](https://drone.io/github.com/tango-contrib/captcha/latest) [](http://gocover.io/github.com/tango-contrib/captcha) Captcha
|
|
- [events](https://github.com/tango-contrib/events) - [](https://drone.io/github.com/tango-contrib/events/latest) [](http://gocover.io/github.com/tango-contrib/events) Before and After
|
|
- [flash](https://github.com/tango-contrib/flash) - [](https://drone.io/github.com/tango-contrib/flash/latest) [](http://gocover.io/github.com/tango-contrib/flash) Share data between requests
|
|
- [debug](https://github.com/tango-contrib/debug) - [](https://drone.io/github.com/tango-contrib/debug/latest) [](http://gocover.io/github.com/tango-contrib/debug) show detail debug infomaton on log
|
|
|
|
## Getting Help
|
|
|
|
- [API Reference](https://gowalker.org/github.com/lunny/tango)
|
|
|
|
## Cases
|
|
|
|
- [Wego](https://github.com/go-tango/wego)
|
|
- [DBWeb](https://github.com/go-xorm/dbweb)
|
|
- [ABlog](https://github.com/fuxiaohei/ablog)
|
|
|
|
## License
|
|
|
|
This project is under BSD License. See the [LICENSE](LICENSE) file for the full license text. |