101 lines
3.7 KiB
Markdown
101 lines
3.7 KiB
Markdown
# Beego [](https://travis-ci.org/beego/beego) [](http://godoc.org/github.com/beego/beego) [](http://golangfoundation.org) [](https://goreportcard.com/report/github.com/beego/beego)
|
|
|
|
Beego is used for rapid development of enterprise application in Go, including RESTful APIs, web apps and backend
|
|
services.
|
|
|
|
It is inspired by Tornado, Sinatra and Flask. beego has some Go-specific features such as interfaces and struct
|
|
embedding.
|
|
|
|
|
|
|
|
Beego is compos of four parts:
|
|
|
|
1. Base modules: including log module, config module, governor module;
|
|
2. Task: is used for running timed tasks or periodic tasks;
|
|
3. Client: including ORM module, httplib module, cache module;
|
|
4. Server: including web module. We will support gRPC in the future;
|
|
|
|
**Please use RELEASE version, or master branch which contains the latest bug fix**
|
|
|
|
## Quick Start
|
|
|
|
[Official website](http://beego.me)
|
|
|
|
[Example](https://github.com/beego/beego-example)
|
|
|
|
> If you could not open official website, go to [beedoc](https://github.com/beego/beedoc)
|
|
|
|
### Web Application
|
|
|
|
|
|
|
|
#### Create `hello` directory, cd `hello` directory
|
|
|
|
mkdir hello
|
|
cd hello
|
|
|
|
#### Init module
|
|
|
|
go mod init
|
|
|
|
#### Download and install
|
|
|
|
go get github.com/beego/beego/v2@latest
|
|
|
|
#### Create file `hello.go`
|
|
|
|
```go
|
|
package main
|
|
|
|
import "github.com/beego/beego/v2/server/web"
|
|
|
|
func main() {
|
|
web.Run()
|
|
}
|
|
```
|
|
|
|
#### Build and run
|
|
|
|
go build hello.go
|
|
./hello
|
|
|
|
#### Go to [http://localhost:8080](http://localhost:8080)
|
|
|
|
Congratulations! You've just built your first **beego** app.
|
|
|
|
## Features
|
|
|
|
* RESTful support
|
|
* [MVC architecture](https://github.com/beego/beedoc/tree/master/en-US/mvc)
|
|
* Modularity
|
|
* [Auto API documents](https://github.com/beego/beedoc/blob/master/en-US/advantage/docs.md)
|
|
* [Annotation router](https://github.com/beego/beedoc/blob/master/en-US/mvc/controller/router.md)
|
|
* [Namespace](https://github.com/beego/beedoc/blob/master/en-US/mvc/controller/router.md#namespace)
|
|
* [Powerful development tools](https://github.com/beego/bee)
|
|
* Full stack for Web & API
|
|
|
|
## Modules
|
|
|
|
* [orm](https://github.com/beego/beedoc/tree/master/en-US/mvc/model)
|
|
* [session](https://github.com/beego/beedoc/blob/master/en-US/module/session.md)
|
|
* [logs](https://github.com/beego/beedoc/blob/master/en-US/module/logs.md)
|
|
* [config](https://github.com/beego/beedoc/blob/master/en-US/module/config.md)
|
|
* [cache](https://github.com/beego/beedoc/blob/master/en-US/module/cache.md)
|
|
* [context](https://github.com/beego/beedoc/blob/master/en-US/module/context.md)
|
|
* [admin](https://github.com/beego/beedoc/blob/master/en-US/module/admin.md)
|
|
* [httplib](https://github.com/beego/beedoc/blob/master/en-US/module/httplib.md)
|
|
* [task](https://github.com/beego/beedoc/blob/master/en-US/module/task.md)
|
|
* [i18n](https://github.com/beego/beedoc/blob/master/en-US/module/i18n.md)
|
|
|
|
## Community
|
|
|
|
* [http://beego.me/community](http://beego.me/community)
|
|
* Welcome to join us in Slack: [https://beego.slack.com invite](https://join.slack.com/t/beego/shared_invite/zt-fqlfjaxs-_CRmiITCSbEqQG9NeBqXKA),
|
|
* QQ Group Group ID:523992905
|
|
* [Contribution Guide](https://github.com/beego/beedoc/blob/master/en-US/intro/contributing.md).
|
|
|
|
## License
|
|
|
|
beego source code is licensed under the Apache Licence, Version 2.0
|
|
(http://www.apache.org/licenses/LICENSE-2.0.html).
|