gf README

The project's README from github.com/gogf/gf. As one markdown file: README.md.

English | 简体中文

goframe logo

Go Reference GoFrame CI OpenSSF Scorecard CII Best Practices Go Report Card Code Coverage Production Ready License

Release GitHub pull requests GitHub closed pull requests GitHub issues GitHub closed issues Stars Forks Ask DeepWiki

A powerful framework for faster, easier, and more efficient project development.

Installation

go get -u github.com/gogf/gf/v2

Documentation

Contributors

💖 Thanks to all the contributors who made GoFrame possible 💖

goframe contributors

License

GoFrame is licensed under the MIT License, 100% free and open-source, forever.

gf (gogf/gf)

Searching Database…

13.3K ·GitHub
What is this?GoFrame is a development framework for Go: you build your backend projects on top of its modules instead of assembling everything yourself. The README bills it as a way to develop faster, easier and more efficiently.
Is it a framework I code against, or an app I install?A framework — a set of Go modules you import into your own project, not an end-user application. The repository itself is written entirely in Go.
How do I get it into my project?Via the Installation section, which points to the official docs: as a Go module dependency of your project, following the standard go get workflow.
What do I need to have installed to work with it?Just the Go toolchain. The repository itself builds with a Makefile and runs its CI on GitHub Actions with docker-compose, but as a consumer you only write Go.
Is the documentation only in Chinese?No — docs ship in English and Chinese: an official English site alongside the original, mirror sites, downloadable offline docs, and a GoDoc API reference.
Can I use it in commercial work?Yes — it is MIT licensed, and the README commits to it staying 100% free and open-source forever.
What does it include besides the core framework?Per its GitHub topics it bundles an ORM, logging, and OpenTelemetry-based tracing and observability, and it targets microservice development with Kubernetes deployment in mind.
Is GoFrame a mature project or a new experiment?It has been on GitHub since 2017 and collected over 13,000 stars; the repo runs CI pipelines with CodeQL security scanning and enforced code formatting.
What are similar projects?gofr, serve, kratos, go-zero, encore, beego, echo, carno.js
Creator
gogf
Size
31 MB
Stars
13.3K
Age
9y
Commits · 90 Days