gf/README.MD

107 lines
4.3 KiB
Plaintext
Raw Normal View History

2018-12-17 13:28:19 +08:00
# GoFrame
<img align="right" height="150px" src="https://goframe.org/cover.png">
2018-11-30 20:38:53 +08:00
2019-01-17 22:20:37 +08:00
[![Go Doc](https://godoc.org/github.com/gogf/gf?status.svg)](https://godoc.org/github.com/gogf/gf)
[![Build Status](https://travis-ci.org/gogf/gf.svg?branch=master)](https://travis-ci.org/gogf/gf)
[![Go Report](https://goreportcard.com/badge/github.com/gogf/gf)](https://goreportcard.com/report/github.com/gogf/gf)
[![Documents](https://img.shields.io/badge/docs-100%25-green.svg)](https://goframe.org)
2019-01-17 22:20:37 +08:00
[![License](https://img.shields.io/github/license/gogf/gf.svg?style=flat)](https://github.com/gogf/gf)
[![Language](https://img.shields.io/badge/language-go-blue.svg)](https://github.com/gogf/gf)
[![Release](https://img.shields.io/github/release/gogf/gf.svg?style=flat)](https://github.com/gogf/gf/releases)
2018-12-17 20:44:38 +08:00
<!--
2019-01-17 22:20:37 +08:00
[![Code Coverage](https://codecov.io/gh/gogf/gf/branch/master/graph/badge.svg)](https://codecov.io/gh/gogf/gf)
[![Code Helper](https://www.codetriage.com/gogf/gf/badges/users.svg)](https://www.codetriage.com/gogf/gf)
2018-12-17 20:44:38 +08:00
-->
2018-12-17 13:02:18 +08:00
2018-11-30 20:37:28 +08:00
`GF(GoFrame)` is a modular, lightweight, loosely coupled, high performance application development framework written in Go. Supporting graceful server, hot updates, multi-domain, multi-port, multi-service, HTTP/HTTPS, dynamic/hook routing and many more features. Providing a series of core components and dozens of practical modules.
2018-08-06 12:59:08 +08:00
2018-11-30 20:43:08 +08:00
# Installation
2018-11-30 20:37:28 +08:00
```
2018-08-06 23:05:07 +08:00
go get -u gitee.com/johng/gf
```
2018-12-22 21:50:47 +08:00
or use `go.mod`
```
require gitee.com/johng/gf latest
```
2018-11-30 20:43:08 +08:00
# Limitation
2018-11-30 20:37:28 +08:00
```
golang version >= 1.9.2
2018-08-06 23:05:07 +08:00
```
2018-11-30 20:43:08 +08:00
# Documentation
2018-11-30 20:37:28 +08:00
2019-01-23 17:33:51 +08:00
* [中文文档](https://goframe.org)
2018-11-30 20:37:28 +08:00
2018-11-30 20:43:08 +08:00
# Architecture
2018-11-20 23:26:58 +08:00
<div align=center>
<img src="https://goframe.org/images/arch.png"/>
2018-11-20 23:26:58 +08:00
</div>
2018-11-30 20:43:08 +08:00
# Quick Start
2018-11-20 23:26:58 +08:00
2018-04-19 11:08:09 +08:00
```go
package main
2018-05-18 15:55:27 +08:00
import (
"gitee.com/johng/gf/g"
"gitee.com/johng/gf/g/net/ghttp"
)
2018-04-19 11:08:09 +08:00
func main() {
2018-05-18 15:55:27 +08:00
s := g.Server()
s.BindHandler("/", func(r *ghttp.Request) {
2018-08-06 12:57:03 +08:00
r.Response.Write("Hello World")
2018-04-19 11:08:09 +08:00
})
s.Run()
}
2018-11-30 20:37:28 +08:00
```
[View More..](https://goframe.org/start/index)
2018-12-27 09:57:54 +08:00
2018-12-22 21:50:47 +08:00
2018-11-30 20:43:08 +08:00
# License
2018-11-30 20:37:28 +08:00
2018-12-27 09:59:56 +08:00
`GF` is licensed under the [MIT License](LICENSE), 100% free and open-source, forever.
2018-12-27 09:49:50 +08:00
2019-01-02 21:43:17 +08:00
# Contributors(TOP 10)
2018-12-27 09:49:50 +08:00
<a href="https://gitee.com/johng" target="_blank" title="John"><img src="https://gitee.com/uploads/27/1309327_johng.png?1530630243" width="60" align="left"></a>
2019-01-02 21:43:17 +08:00
<a href="https://gitee.com/wenzi1" target="_blank" title="蚊子"><img src="https://images.gitee.com/uploads/22/1923122_wenzi1.png" width="60" align="left"></a>
2018-12-27 09:49:50 +08:00
<a href="https://gitee.com/zseeker" target="_blank" title="zseeker"><img src="https://goframe.org/images/contributors/zseeker.png" width="60" align="left"></a>
2018-12-27 09:49:50 +08:00
2018-12-27 20:47:13 +08:00
<a href="https://gitee.com/ymrjqyy" target="_blank" title="一墨染尽青衣颜"><img src="https://images.gitee.com/uploads/27/876827_ymrjqyy.png" width="60" align="left"></a>
2018-12-27 09:49:50 +08:00
<a href="https://github.com/chenyang351" target="_blank" title="chenyang351"><img src="https://avatars1.githubusercontent.com/u/30063958?s=60&v=4" width="60" align="left"></a>
<a href="https://gitee.com/wxkj" target="_blank" title="wxkj"><img src="https://gitee.com/uploads/56/91356_wxkj.png" width="60" align="left"></a>
<a href="https://github.com/wxkj001" target="_blank" title="3wxkj001
"><img src="https://avatars0.githubusercontent.com/u/7794279?s=60&v=4" width="60" align="left"></a>
2018-12-27 20:47:13 +08:00
<a href="https://gitee.com/zhangjinfu" target="_blank" title="张金富"><img src="https://images.gitee.com/uploads/63/356163_zhangjinfu.png" width="60" align="left"></a>
2018-12-27 09:49:50 +08:00
<a href="https://gitee.com/garfieldkwong" target="_blank" title="GarfieldKwong"><img src="https://goframe.org/images/contributors/garfieldkwong.png" width="60" align="left"></a>
2018-12-27 09:49:50 +08:00
2019-01-02 21:43:17 +08:00
<a href="https://gitee.com/qq1054000800" target="_blank" title="hello"><img src="https://gitee.com/uploads/9/2209_qq1054000800.jpg" width="60" align="left"></a>
2018-12-27 13:27:57 +08:00
<br /><br /><br />
2018-12-27 09:49:50 +08:00
# Donators
2019-01-17 20:04:17 +08:00
<a href="https://gitee.com/zhuhuan12" target="_blank" title="zhuhuan12"><img src="https://gitee.com/uploads/39/751839_zhuhuan12.png" width="60" align="left"></a>
2018-12-27 09:49:50 +08:00
<a href="https://gitee.com/zfan_codes" target="_blank" title="范钟"><img src="https://images.gitee.com/uploads/32/2044832_zfan_codes.png" width="60" align="left"></a>
<a href="https://gitee.com/hailaz" target="_blank" title="HaiLaz"><img src="https://gitee.com/uploads/87/1273187_hailaz.png" width="60" align="left"></a>
<a href="https://gitee.com/mg91" target="_blank" title="mg91"><img src="https://images.gitee.com/uploads/30/1410930_mg91.png" width="60" align="left"></a>