gf/README.MD

65 lines
2.0 KiB
Plaintext
Raw Normal View History

2018-12-17 13:28:19 +08:00
# GoFrame
<img align="right" height="150px" src="https://gfer.me/cover.png">
2018-11-30 20:38:53 +08:00
2018-12-17 13:28:19 +08:00
[![Go Doc](https://godoc.org/github.com/johng-cn/gf?status.svg)](https://godoc.org/github.com/johng-cn/gf)
[![Build Status](https://travis-ci.org/johng-cn/gf.svg?branch=master)](https://travis-ci.org/johng-cn/gf)
[![Go Report](https://goreportcard.com/badge/github.com/johng-cn/gf)](https://goreportcard.com/report/github.com/johng-cn/gf)
2018-12-17 20:44:38 +08:00
[![Documents](https://img.shields.io/badge/docs-100%25-green.svg)](https://gfer.me)
[![License](https://img.shields.io/github/license/johng-cn/gf.svg?style=flat)](https://github.com/johng-cn/gf)
2018-12-17 20:51:49 +08:00
[![Language](https://img.shields.io/badge/language-go-blue.svg)](https://github.com/johng-cn/gf)
2018-12-17 20:44:38 +08:00
[![Release](https://img.shields.io/github/release/johng-cn/gf.svg?style=flat)](https://github.com/johng-cn/gf/releases)
<!--
2018-12-17 19:50:35 +08:00
[![Code Coverage](https://codecov.io/gh/johng-cn/gf/branch/master/graph/badge.svg)](https://codecov.io/gh/johng-cn/gf)
2018-12-17 13:28:19 +08:00
[![Code Helper](https://www.codetriage.com/johng-cn/gf/badges/users.svg)](https://www.codetriage.com/johng-cn/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
* [中文文档](https://gfer.me/)
2018-11-30 20:43:08 +08:00
# Architecture
2018-11-20 23:26:58 +08:00
<div align=center>
<img src="https://gfer.me/images/arch.png"/>
</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
```
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
GF is licensed under the [MIT License](LICENSE), 100% free and open-source.