github.com/wangyougui/gf/v2@v2.6.5/README.MD (about)

     1  # GoFrame
     2  
     3  <div align=center>
     4  <img src="https://goframe.org/statics/image/logo2.png?v=1" width="300"/>
     5  
     6  [![Go Reference](https://pkg.go.dev/badge/github.com/wangyougui/gf/v2.svg)](https://pkg.go.dev/github.com/wangyougui/gf/v2)
     7  [![GoFrame CI](https://github.com/wangyougui/gf/actions/workflows/ci-main.yml/badge.svg)](https://github.com/wangyougui/gf/actions/workflows/ci-main.yml)
     8  [![Go Report Card](https://goreportcard.com/badge/github.com/wangyougui/gf/v2)](https://goreportcard.com/report/github.com/wangyougui/gf/v2)
     9  [![Code Coverage](https://codecov.io/gh/gogf/gf/branch/master/graph/badge.svg)](https://codecov.io/gh/gogf/gf)
    10  [![Production Ready](https://img.shields.io/badge/production-ready-blue.svg?style=flat)](https://github.com/wangyougui/gf)
    11  [![License](https://img.shields.io/github/license/gogf/gf.svg?style=flat)](https://github.com/wangyougui/gf)
    12  
    13  [![Release](https://img.shields.io/github/v/release/gogf/gf?style=flat)](https://github.com/wangyougui/gf/releases)
    14  [![GitHub pull requests](https://img.shields.io/github/issues-pr/gogf/gf?style=flat)](https://github.com/wangyougui/gf/pulls)
    15  [![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/gogf/gf?style=flat)](https://github.com/wangyougui/gf/pulls?q=is%3Apr+is%3Aclosed)
    16  [![GitHub issues](https://img.shields.io/github/issues/gogf/gf?style=flat)](https://github.com/wangyougui/gf/issues)
    17  [![GitHub closed issues](https://img.shields.io/github/issues-closed/gogf/gf?style=flat)](https://github.com/wangyougui/gf/issues?q=is%3Aissue+is%3Aclosed)
    18  ![Stars](https://img.shields.io/github/stars/gogf/gf?style=flat)
    19  ![Forks](https://img.shields.io/github/forks/gogf/gf?style=flat)
    20  
    21  </div>
    22  
    23  `GoFrame` is a modular, powerful, high-performance and enterprise-class application development framework of Golang.
    24  
    25  # Features
    26  
    27  - modular, loosely coupled design
    28  - rich components, out-of-the-box
    29  - automatic codes generating for efficiency
    30  - simple and easy to use, detailed documentation
    31  - interface designed components, with high scalability
    32  - fully supported tracing and error stack feature
    33  - specially developed and powerful ORM component
    34  - robust engineering design specifications
    35  - convenient development CLI tool provide
    36  - OpenTelemetry observability features support
    37  - OpenAPIV3 documentation generating, automatically
    38  - much, much more...ready to explore?
    39  
    40  # Installation
    41  
    42  Enter your repo. directory and execute following command:
    43  
    44  ## primary module
    45  
    46  ```bash
    47  go get -u -v github.com/wangyougui/gf/v2
    48  ```
    49  
    50  ## cli tool
    51  
    52  ```bash
    53  go install github.com/wangyougui/gf/cmd/gf/v2@latest
    54  ```
    55  
    56  # Limitation
    57  
    58  ```
    59  golang version >= 1.18
    60  ```
    61  
    62  # Documentation
    63  
    64  - Chinese Official Site(中文官网): [https://goframe.org](https://goframe.org/display/gf)
    65  - Chinese Pages Document(中文镜像文档): [https://pages.goframe.org](https://pages.goframe.org)
    66  - Chinese Offline Document(中文离线文档): [https://github.com/gogf/goframe.org-pdf](https://github.com/gogf/goframe.org-pdf)
    67  - GoDoc API: [https://pkg.go.dev/github.com/wangyougui/gf/v2](https://pkg.go.dev/github.com/wangyougui/gf/v2)
    68  
    69  # License
    70  
    71  `GoFrame` is licensed under the [MIT License](LICENSE), 100% free and open-source, forever.
    72  
    73  # Part Of Users
    74  
    75  - [Tencent](https://www.tencent.com/)
    76  - [ZTE](https://www.zte.com.cn/china/)
    77  - [Ant Financial Services](https://www.antfin.com/)
    78  - [VIVO](https://www.vivo.com/)
    79  - [MedLinker](https://www.medlinker.com/)
    80  - [KuCoin](https://www.kucoin.io/)
    81  - [LeYouJia](https://www.leyoujia.com/)
    82  - [IGG](https://igg.com)
    83  - [37](https://www.37.com)
    84  - [XiMaLaYa](https://www.ximalaya.com)
    85  - [ZYBang](https://www.zybang.com/)
    86  
    87  > 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).
    88  
    89  # Contributors
    90  
    91  This project exists thanks to all the people who contribute. [[Contributors](https://github.com/wangyougui/gf/graphs/contributors)].
    92  <a href="https://github.com/wangyougui/gf/graphs/contributors"><img src="https://contributors-img.web.app/image?repo=gogf/gf" /></a>
    93  
    94  # Donators
    95  
    96  If you love `GoFrame`, why not [buy developer a cup of coffee](https://goframe.org/pages/viewpage.action?pageId=1115633)?
    97  
    98  # Sponsors
    99  
   100  We appreciate any kind of sponsorship for `GoFrame` development. If you've got some interesting, please contact WeChat `389961817` / Email `john@goframe.org`.
   101  
   102  # Thanks
   103  
   104  <a href="https://www.jetbrains.com/?from=GoFrame"><img src="https://goframe.org/download/thumbnails/1114119/jetbrains.png" height="120" alt="JetBrains"/></a>
   105  <a href="https://www.atlassian.com/?from=GoFrame"><img src="https://goframe.org/download/attachments/1114119/atlassian.jpg" height="120" alt="Atlassian"/></a>