Files
gf/README.MD
2021-04-16 10:21:42 +08:00

115 lines
6.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# GoFrame
[![Go Doc](https://godoc.org/github.com/gogf/gf?status.svg)](https://godoc.org/github.com/gogf/gf)
[![Build Status](https://travis-ci.com/gogf/gf.svg?branch=master)](https://travis-ci.org/gogf/gf)
[![Go Report](https://goreportcard.com/badge/github.com/gogf/gf?v=1)](https://goreportcard.com/report/github.com/gogf/gf)
[![Code Coverage](https://codecov.io/gh/gogf/gf/branch/master/graph/badge.svg)](https://codecov.io/gh/gogf/gf/branch/master)
[![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)
English | [简体中文](README_ZH.MD)
`GoFrame` is a modular, powerful, high-performance and enterprise-class application development framework
of Golang.
> 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`.
# Installation
```
go get -u -v github.com/gogf/gf
```
suggested using `go.mod`:
```
require github.com/gogf/gf latest
```
# Limitation
```
golang version >= 1.11
```
# Architecture
<div align=center>
<img src="https://goframe.org/download/attachments/1114119/arch.png"/>
</div>
# Packages
1. **Primary Package**
The `gf` repository maintains some basic and most commonly used packages, keeping it as lightweight and simple as possible.
1. **Community Package**
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.
# Performance
The `Web` component performance of `GoFrame`, please refer to third-party project: https://github.com/the-benchmarker/web-frameworks
# Documentation
* 中文官网: https://goframe.org
* GoDoc API: https://godoc.org/github.com/gogf/gf
# Discussion
- QQ GroupScan QR or search group ID in QQ
<table class="confluenceTable"><colgroup><col><col></colgroup><tbody><tr><th style="text-align: center;" class="confluenceTh"><div class="content-wrapper"><p>GoFrame实战1群(满)</p></div></th><th style="text-align: center;" class="confluenceTh">GoFrame实战2群</th></tr><tr><td class="confluenceTd"><div class="content-wrapper"><p><span class="confluence-embedded-file-wrapper image-center-wrapper confluence-embedded-manual-size"><img class="confluence-embedded-image confluence-thumbnail image-center" height="150" src="https://gfcdn.johng.cn/download/thumbnails/1114119/1618482270275.png?version=1&amp;modificationDate=1618482279553&amp;api=v2" data-image-src="https://gfcdn.johng.cn/download/attachments/1114119/1618482270275.png?version=1&amp;modificationDate=1618482279553&amp;api=v2" data-unresolved-comment-count="0" data-linked-resource-id="7296919" data-linked-resource-version="1" data-linked-resource-type="attachment" data-linked-resource-default-alias="1618482270275.png" data-base-url="https://goframe.org" data-linked-resource-content-type="image/png" data-linked-resource-container-id="1114119" data-linked-resource-container-version="68"></span></p><p style="text-align: center;">116707870</p></div></td><td class="confluenceTd"><div class="content-wrapper"><p><span class="confluence-embedded-file-wrapper image-center-wrapper confluence-embedded-manual-size"><img class="confluence-embedded-image confluence-thumbnail image-center" height="150" src="https://gfcdn.johng.cn/download/thumbnails/1114119/1618482221516.png?version=1&amp;modificationDate=1618482239045&amp;api=v2" data-image-src="https://gfcdn.johng.cn/download/attachments/1114119/1618482221516.png?version=1&amp;modificationDate=1618482239045&amp;api=v2" data-unresolved-comment-count="0" data-linked-resource-id="7296918" data-linked-resource-version="1" data-linked-resource-type="attachment" data-linked-resource-default-alias="1618482221516.png" data-base-url="https://goframe.org" data-linked-resource-content-type="image/png" data-linked-resource-container-id="1114119" data-linked-resource-container-version="68"></span></p><p style="text-align: center;">74341849</p></div></td></tr></tbody></table>
- WX GroupScan QR or search `389961817` in WeChat, commenting `GF`
<table class="confluenceTable"><colgroup><col></colgroup><tbody><tr><th style="text-align: center;" class="confluenceTh"><div class="content-wrapper"><p>添加后拉群</p></div></th></tr><tr><td class="confluenceTd"><div class="content-wrapper"><p><span class="confluence-embedded-file-wrapper confluence-embedded-manual-size"><img class="confluence-embedded-image confluence-thumbnail" width="150" src="https://gfcdn.johng.cn/download/thumbnails/1114119/image2021-4-15_19-23-42.png?version=1&amp;modificationDate=1618485986477&amp;api=v2" data-image-src="https://gfcdn.johng.cn/download/attachments/1114119/image2021-4-15_19-23-42.png?version=1&amp;modificationDate=1618485986477&amp;api=v2" data-unresolved-comment-count="0" data-linked-resource-id="7296922" data-linked-resource-version="1" data-linked-resource-type="attachment" data-linked-resource-default-alias="image2021-4-15_19-23-42.png" data-base-url="https://goframe.org" data-linked-resource-content-type="image/png" data-linked-resource-container-id="1114119" data-linked-resource-container-version="68"></span></p></div></td></tr></tbody></table>
- Issueshttps://github.com/gogf/gf/issues
> It's recommended learning `GoFrame` through its awesome source codes and API reference.
# License
`GF` is licensed under the [MIT License](LICENSE), 100% free and open-source, forever.
# Part Of Users
- [Tencent](https://www.tencent.com/)
- [ZTE](https://www.zte.com.cn/china/)
- [Ant Financial Services](https://www.antfin.com/)
- [MedLinker](https://www.medlinker.com/)
- [KuCoin](https://www.kucoin.io/)
- [LeYouJia](https://www.leyoujia.com/)
- [IGG](https://igg.com)
- [XiMaLaYa](https://www.ximalaya.com)
- [ZYBang](https://www.zybang.com/)
> 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).
# 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>
# Donators
If you love `GF`, why not [buy developer a cup of coffee](https://goframe.org/pages/viewpage.action?pageId=1115633)?
# Sponsors
We appreciate any kind of sponsorship for `GF` development. If you've got some interesting, please contact WeChat `389961817` / Email `john@goframe.org`.
# Thanks
<a href="https://www.jetbrains.com/?from=GoFrame"><img src="https://goframe.org/download/thumbnails/1114119/jetbrains.png" height="120" alt="JetBrains"/></a>
<a href="https://www.atlassian.com/?from=GoFrame"><img src="https://goframe.org/download/attachments/1114119/atlassian.jpg" height="120" alt="Atlassian"/></a>