2021-03-30 17:39:56 +08:00
# GoFrame
2023-03-17 17:54:14 +08:00
2022-01-12 20:42:11 +08:00
<div align=center>
2023-05-16 09:55:21 +08:00
<img src="https://goframe.org/statics/image/logo2.png?v=1" width="300"/>
2018-12-17 20:44:38 +08:00
2023-05-11 20:44:56 +08:00
[](https://pkg.go.dev/github.com/gogf/gf/v2)
2023-10-24 20:33:10 +08:00
[](https://github.com/gogf/gf/actions/workflows/ci-main.yml)
2023-03-17 17:54:14 +08:00
[](https://goreportcard.com/report/github.com/gogf/gf/v2)
2023-03-07 21:27:23 +08:00
[](https://codecov.io/gh/gogf/gf)
2024-01-03 19:49:06 +08:00
[](https://github.com/gogf/gf)
2021-03-30 18:00:44 +08:00
[](https://github.com/gogf/gf)
2023-12-15 15:56:08 +08:00
2024-01-03 19:49:06 +08:00
[](https://github.com/gogf/gf/releases)
[](https://github.com/gogf/gf/pulls)
[](https://github.com/gogf/gf/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/gogf/gf/issues)
[](https://github.com/gogf/gf/issues?q=is%3Aissue+is%3Aclosed)
2023-12-15 15:56:08 +08:00
2022-01-12 20:43:36 +08:00
</div>
2021-03-30 18:00:44 +08:00
2023-03-17 17:54:14 +08:00
`GoFrame` is a modular, powerful, high-performance and enterprise-class application development framework of Golang.
2018-08-06 12:59:08 +08:00
2022-01-12 20:42:11 +08:00
# Features
2023-03-17 17:54:14 +08:00
2022-01-12 20:42:11 +08:00
- modular, loosely coupled design
- rich components, out-of-the-box
2022-01-24 15:50:15 +08:00
- automatic codes generating for efficiency
2022-01-12 20:42:11 +08:00
- simple and easy to use, detailed documentation
- interface designed components, with high scalability
- fully supported tracing and error stack feature
- specially developed and powerful ORM component
- robust engineering design specifications
- convenient development CLI tool provide
- OpenTelemetry observability features support
- OpenAPIV3 documentation generating, automatically
- much, much more...ready to explore?
2020-02-22 17:06:58 +08:00
2019-06-25 23:17:14 +08:00
# Installation
2023-03-17 17:54:14 +08:00
2022-01-25 10:21:59 +08:00
Enter your repo. directory and execute following command:
2022-01-24 15:50:15 +08:00
## primary module
2023-03-17 17:54:14 +08:00
2022-01-24 15:50:15 +08:00
```bash
2021-10-11 21:43:27 +08:00
go get -u -v github.com/gogf/gf/v2
2018-08-06 23:05:07 +08:00
```
2022-01-24 15:50:15 +08:00
## cli tool
2023-03-17 17:54:14 +08:00
2022-01-24 15:50:15 +08:00
```bash
2023-10-23 20:00:10 +08:00
go install github.com/gogf/gf/cmd/gf/v2@latest
2018-12-22 21:50:47 +08:00
```
2019-06-25 23:17:14 +08:00
# Limitation
2023-03-17 17:54:14 +08:00
2018-11-30 20:37:28 +08:00
```
2023-08-03 21:14:48 +08:00
golang version >= 1.18
2019-06-25 23:17:14 +08:00
```
2020-04-23 17:23:57 +08:00
# Documentation
2023-03-17 17:54:14 +08:00
- Chinese Official Site(中文官网): [https://goframe.org](https://goframe.org/display/gf)
2024-01-25 20:47:21 +08:00
- Offline Document(中文离线文档): [https://github.com/gogf/goframe.org-pdf](https://github.com/gogf/goframe.org-pdf)
2023-03-17 17:54:14 +08:00
- GoDoc API: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2)
2020-04-23 17:23:57 +08:00
2019-06-25 23:17:14 +08:00
# License
2021-12-04 00:07:49 +08:00
`GoFrame` is licensed under the [MIT License](LICENSE), 100% free and open-source, forever.
2019-06-25 23:17:14 +08:00
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/)
2021-12-04 00:07:05 +08:00
- [VIVO](https://www.vivo.com/)
2021-12-04 18:25:24 +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)
2021-12-04 00:05:54 +08:00
- [37](https://www.37.com)
2020-08-13 18:59:13 +08:00
- [XiMaLaYa](https://www.ximalaya.com)
2020-11-20 00:53:12 +08:00
- [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
2023-03-17 17:54:14 +08:00
2020-01-18 22:21:37 +08:00
This project exists thanks to all the people who contribute. [[Contributors](https://github.com/gogf/gf/graphs/contributors)].
2021-09-20 12:29:05 +08:00
<a href="https://github.com/gogf/gf/graphs/contributors"><img src="https://contributors-img.web.app/image?repo=gogf/gf" /></a>
2020-01-18 22:21:37 +08:00
2019-06-25 23:17:14 +08:00
# Donators
2021-12-04 00:07:49 +08:00
If you love `GoFrame`, 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
2023-03-17 17:54:14 +08:00
We appreciate any kind of sponsorship for `GoFrame` development. If you've got some interesting, please contact WeChat `389961817` / Email `john@goframe.org`.
2020-06-05 20:36:05 +08:00
2019-06-25 23:17:14 +08:00
# Thanks
2023-03-17 17:54:14 +08:00
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>
