https://github.com/mingderwang/gas
Gas is a web framework writing in go
https://github.com/mingderwang/gas
Last synced: over 1 year ago
JSON representation
Gas is a web framework writing in go
- Host: GitHub
- URL: https://github.com/mingderwang/gas
- Owner: mingderwang
- License: mit
- Created: 2016-07-01T04:27:07.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-06-30T15:03:57.000Z (about 10 years ago)
- Last Synced: 2025-03-25T07:51:12.800Z (over 1 year ago)
- Language: Go
- Size: 960 KB
- Stars: 2
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gas
[](https://api.travis-ci.org/go-gas/gas.svg) [](https://codecov.io/gh/go-gas/gas) [](https://goreportcard.com/report/github.com/go-gas/gas)
Gas is a Web framework written in Go. And this is not a total complete project.
I just did a minimum workable architechture.
The workable feature is:
- Router (based on [fasthttprouter](https://github.com/buaazp/fasthttprouter) package)
- Context (It can easy to render view and print json string)
- Middleware
- Logger middleware
- Log package
- Read config from a yaml file
And Model is not complete yet. Just finished MySQL sql Builder
##### all feature you can see in Example Directory.
# Install
```
$ go get github.com/go-gas/gas
```
# Run demo
```
$ cd $GOPATH/src/github.com/go-gas/gas/Example
$ go run main.go
```
# Your project file structure
|-- $GOPATH
| |-- src
| |--Your_Project_Name
| |-- config
| |-- default.yaml
| |-- controllers
| |-- default.go
| |-- log
| |-- models
| |-- routers
| |-- routers.go
| |-- static
| |-- views
| |-- main.go
# Quick start
### Import
```go
import (
"Your_Project_Name/routers"
"github.com/go-gas/gas"
"github.com/go-gas/gas/middleware"
)
```
### New
```go
g := gas.New() // will load "config/default.yaml"
```
or
```go
g := gas.New("config/path")
```
### Register Routes
```go
routers.RegistRout(g.Router)
```
Then in your routers.go
```go
package routers
import (
"Your_Project_Name/controllers"
"github.com/go-gas/gas"
)
func RegistRout(r *gas.Router) {
r.Get("/", controllers.IndexPage)
r.Post("/post/:param", controllers.PostTest)
rc := &controllers.RestController{}
r.REST("/User", rc)
}
```
### Register middleware
```go
g.Router.Use(middleware.LogMiddleware)
```
And you can write your own middleware function
```go
func LogMiddleware(next gas.CHandler) gas.CHandler {
return func (c *gas.Context) error {
// do something before next handler
err := next(c)
// do something after next handler
return err
}
}
```
### And done
```go
g.Run()
```
# Benchmark
Using [go-web-framework-benchmark](https://github.com/smallnest/go-web-framework-benchmark) to benchmark with another web fframework.
#### Benchmark-alloc
#### Benchmark-latency
#### Benchmark-pipeline
## Concurrency
#### Concurrency-alloc
#### Concurrency-latency
#### Concurrency-pipeline
## Benchmark conclusion
[Iris](https://github.com/kataras/iris) is still the fastest web framework.
But gas is very new, so in the future
I wish this framework might not be a fastest but it will very fast and full featured.
### Roadmap
- [ ] Models
- [ ] Model fields mapping
- [ ] ORM
- [ ] Relation mapping
- [x] Transaction
- [ ] QueryBuilder
- [ ] Session
- [ ] Filesystem
- [ ] Database
- [ ] Redis
- [ ] Memcache
- [ ] Cache
- [ ] Memory
- [ ] File
- [ ] Redis
- [ ] Memcache
- [ ] i18n
- [ ] HTTPS
- [ ] Command line tools
- [ ] Form handler (maybe next version)
- [ ] Security check features(csrf, xss filter...etc)