gf/README.MD

104 lines
3.4 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)
2019-03-08 09:03:32 +08:00
[![Code Coverage](https://codecov.io/gh/gogf/gf/branch/master/graph/badge.svg)](https://codecov.io/gh/gogf/gf/branch/master)
2019-04-07 22:03:04 +08:00
[![Production Ready](https://img.shields.io/badge/production-ready-blue.svg)](https://github.com/gogf/gf)
[![License](https://img.shields.io/github/license/gogf/gf.svg?style=flat)](https://github.com/gogf/gf)
2018-12-17 20:44:38 +08:00
2019-03-08 00:15:57 +08:00
<!--
GoFrame is a modular, loose-coupled, production-ready and most-powerful application development framework of golang. Providing a series of core components and dozens of practical modules, such as: cache, logging, containers, timer, validator, database orm, etc. Supporting web server integrated with router, cookie, session, logger, configure, template, https, hooks, rewrites and many more features.
-->
`GF(GoFrame)` is a modular, loose-coupled, production-ready and most-powerful application development framework of golang. Providing a series of core components and dozens of practical modules, such as: memcache, configure, validator, logging, array/queue/set/map containers, timer/timing tasks, file/memory lock, object pool, database ORM, etc. Supporting web server integrated with router, cookie, session, logger, template, https, hooks, rewrites and many more features.
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
```
go get -u github.com/gogf/gf
2018-08-06 23:05:07 +08:00
```
2019-02-15 23:21:46 +08:00
or use `go.mod`:
2018-12-22 21:50:47 +08:00
```
require github.com/gogf/gf latest
2018-12-22 21:50:47 +08:00
```
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-04-07 21:59:28 +08:00
* [APIDoc](https://godoc.org/github.com/gogf/gf)
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 (
"github.com/gogf/gf/g"
"github.com/gogf/gf/g/net/ghttp"
2018-05-18 15:55:27 +08:00
)
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-03-18 14:10:30 +08:00
# Contributors
2019-04-10 23:09:38 +08:00
- [aloncn](https://github.com/aloncn)
2019-04-07 21:49:24 +08:00
- [chenyang351](https://github.com/chenyang351)
- [garfieldkwong](https://gitee.com/garfieldkwong)
- [hailaz](https://gitee.com/hailaz)
2019-04-17 09:50:57 +08:00
- [johng](https://johng.cn)
- [jroam](https://github.com/jroam)
2019-04-07 21:49:24 +08:00
- [pibigstar](https://github.com/pibigstar)
- [qq1054000800](https://gitee.com/qq1054000800)
2019-04-11 23:07:22 +08:00
- [qq976739120](https://github.com/qq976739120)
2019-03-18 14:10:30 +08:00
- [wenzi1](https://gitee.com/wenzi1)
- [wxkj001](https://github.com/wxkj001)
2019-04-07 21:49:24 +08:00
- [ymrjqyy](https://gitee.com/ymrjqyy)
- [youyixiao](https://github.com/youyixiao)
2019-03-18 14:10:30 +08:00
- [zhangjinfu](https://gitee.com/zhangjinfu)
2019-04-07 21:49:24 +08:00
- [zhaopengme](https://github.com/zhaopengme)
- [zseeker](https://gitee.com/zseeker)
2018-12-27 09:49:50 +08:00
# Donators
2019-04-07 21:59:28 +08:00
- [flyke-xu](https://gitee.com/flyke-xu)
2019-03-18 14:10:30 +08:00
- [hailaz](https://gitee.com/hailaz)
- [ireadx](https://github.com/ireadx)
2019-03-18 14:10:30 +08:00
- [mg91](https://gitee.com/mg91)
- [pibigstar](https://github.com/pibigstar)
2019-04-07 21:59:28 +08:00
- [tiangenglan](https://gitee.com/tiangenglan)
- [wxkj](https://gitee.com/wxkj)
- [zhuhuan12](https://gitee.com/zhuhuan12)
- [zfan_codes](https://gitee.com/zfan_codes)
2018-12-27 09:49:50 +08:00