gf/README.MD

114 lines
4.1 KiB
Plaintext
Raw Normal View History

2019-06-19 09:09:13 +08:00
# GoFrame
2018-11-30 20:38:53 +08:00
[![Go Doc](https://godoc.org/github.com/gogf/gf?status.svg)](https://godoc.org/github.com/gogf/gf)
2021-02-07 15:34:36 +08:00
[![Build Status](https://travis-ci.com/gogf/gf.svg?branch=master)](https://travis-ci.org/gogf/gf)
2019-06-22 22:06:13 +08:00
[![Go Report](https://goreportcard.com/badge/github.com/gogf/gf?v=1)](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-08-30 22:15:54 +08:00
English | [简体中文](README_ZH.MD)
2019-05-18 13:52:18 +08:00
2020-12-23 13:28:12 +08:00
`GF(GoFrame)` is a modular, powerful, high-performance and enterprise-class application development framework
of Golang. Providing a series of core components and dozens of practical modules, such as:
2020-04-03 09:32:04 +08:00
cache, logging, containers, timer, resource, validator, database orm, etc.
Supporting web server integrated with router, cookie, session, middleware, logger, configure,
template, https, hooks, rewrites and many more features.
2018-08-06 12:59:08 +08:00
2020-04-29 19:33:14 +08:00
> If you're a newbie to `Go`, you may consider `GoFrame` easy and great as `Laravel` in `PHP`, `SpringBoot` in `Java` or `Django` in `Python`.
2020-02-22 17:06:58 +08:00
2019-06-25 23:17:14 +08:00
# Installation
```
2019-10-13 23:05:48 +08:00
go get -u -v github.com/gogf/gf
2018-08-06 23:05:07 +08:00
```
2019-08-30 22:15:54 +08:00
suggested using `go.mod`:
2018-12-22 21:50:47 +08:00
```
require github.com/gogf/gf latest
2018-12-22 21:50:47 +08:00
```
2019-06-25 23:17:14 +08:00
# Limitation
2018-11-30 20:37:28 +08:00
```
2020-04-23 21:06:42 +08:00
golang version >= 1.11
2019-06-25 23:17:14 +08:00
```
2020-07-12 10:25:15 +08:00
# Architecture
<div align=center>
2021-02-07 15:34:36 +08:00
<img src="https://goframe.org/download/attachments/1114119/arch.png"/>
2020-07-12 10:25:15 +08:00
</div>
2020-05-17 15:11:07 +08:00
# Packages
1. **Primary Package**
2020-05-17 15:11:07 +08:00
The `gf` repository maintains some basic and most commonly used packages, keeping it as lightweight and simple as possible.
1. **Community Package**
2020-05-17 15:11:07 +08:00
2020-06-04 17:29:16 +08:00
The community packages are contributed and maintained by community members, which are hosted in `gogf` organization. Some of the community packages are separated from the `gf` repository, which are not of common usage or are with heavy dependencies.
2020-05-17 15:11:07 +08:00
2020-04-23 17:14:11 +08:00
# Performance
2020-12-23 13:26:33 +08:00
The `Web` component performance of `GoFrame`, please refer to third-party project: https://github.com/the-benchmarker/web-frameworks
2020-04-23 17:14:11 +08:00
2020-04-23 17:18:15 +08:00
2019-06-25 23:17:14 +08:00
2020-04-23 17:23:57 +08:00
# Documentation
* 中文官网: https://goframe.org
* GoDoc API: https://godoc.org/github.com/gogf/gf
# Discussion
- QQ Group[116707870](//shang.qq.com/wpa/qunwpa?idkey=195f91eceeb5d7fa76009b7cd5a4641f70bf4897b7f5a520635eb26ff17adfe7)
- WX GroupAdd friend`389961817` in WeChat, commenting `GF`
- Issueshttps://github.com/gogf/gf/issues
> It's recommended learning `GoFrame` through its awesome source codes and API reference.
2019-06-25 23:17:14 +08:00
# License
`GF` is licensed under the [MIT License](LICENSE), 100% free and open-source, forever.
2020-07-18 09:40:39 +08:00
# Part Of Users
2020-06-05 20:36:05 +08:00
2020-07-18 10:34:32 +08:00
- [Tencent](https://www.tencent.com/)
2020-07-18 09:40:39 +08:00
- [ZTE](https://www.zte.com.cn/china/)
- [Ant Financial Services](https://www.antfin.com/)
2020-08-03 18:58:43 +08:00
- [MedLinker](https://www.medlinker.com/)
2020-07-18 09:40:39 +08:00
- [KuCoin](https://www.kucoin.io/)
2020-08-03 18:58:43 +08:00
- [LeYouJia](https://www.leyoujia.com/)
- [IGG](https://igg.com)
2020-08-13 18:59:13 +08:00
- [XiMaLaYa](https://www.ximalaya.com)
- [ZYBang](https://www.zybang.com/)
2020-07-18 09:40:39 +08:00
2021-02-07 15:34:36 +08:00
> We list part of the users here, if your company or products are using `GoFrame`, please let us know [here](https://goframe.org/pages/viewpage.action?pageId=1114415).
2020-06-05 20:36:05 +08:00
2020-01-18 22:21:37 +08:00
# Contributors
This project exists thanks to all the people who contribute. [[Contributors](https://github.com/gogf/gf/graphs/contributors)].
<a href="https://github.com/gogf/gf/graphs/contributors"><img src="https://opencollective.com/goframe/contributors.svg?width=890&button=false" /></a>
2020-06-03 20:33:21 +08:00
2019-06-25 23:17:14 +08:00
# Donators
2021-02-07 15:34:36 +08:00
If you love `GF`, why not [buy developer a cup of coffee](https://goframe.org/pages/viewpage.action?pageId=1115633)?
2019-06-25 23:17:14 +08:00
2020-02-22 17:06:58 +08:00
# Sponsors
We appreciate any kind of sponsorship for `GF` development. If you've got some interesting, please contact WeChat `389961817` / Email `john@goframe.org`.
2020-06-03 20:33:21 +08:00
2020-02-22 17:06:58 +08:00
2020-06-05 20:36:05 +08:00
2019-06-25 23:17:14 +08:00
# Thanks
2021-02-07 15:34:36 +08:00
<a href="https://www.jetbrains.com/?from=GoFrame"><img src="https://goframe.org/download/thumbnails/1114119/jetbrains.png" height="120" alt="JetBrains"/></a>
2021-02-07 10:31:59 +08:00
<a href="https://www.atlassian.com/?from=GoFrame"><img src="https://goframe.org/download/attachments/1114119/atlassian.jpg" height="120" alt="Atlassian"/></a>
2018-12-27 09:49:50 +08:00
2020-02-22 17:06:58 +08:00
2019-05-18 14:55:15 +08:00
2020-06-05 20:36:05 +08:00