Beego/README.md

65 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2017-11-25 17:23:46 +00:00
# Beego [![Build Status](https://travis-ci.org/astaxie/beego.svg?branch=master)](https://travis-ci.org/astaxie/beego) [![GoDoc](http://godoc.org/github.com/astaxie/beego?status.svg)](http://godoc.org/github.com/astaxie/beego) [![Foundation](https://img.shields.io/badge/Golang-Foundation-green.svg)](http://golangfoundation.org) [![Go Report Card](https://goreportcard.com/badge/github.com/astaxie/beego)](https://goreportcard.com/report/github.com/astaxie/beego)
2013-06-19 14:27:21 +00:00
beego is used for rapid development of RESTful APIs, web apps and backend services in Go.
It is inspired by Tornado, Sinatra and Flask. beego has some Go-specific features such as interfaces and struct embedding.
2012-12-16 15:43:42 +00:00
2017-04-02 09:04:08 +00:00
###### More info at [beego.me](http://beego.me).
## Quick Start
2013-06-22 11:17:50 +00:00
#### Download and install
go get github.com/astaxie/beego
2017-04-02 09:04:08 +00:00
#### Create file `hello.go`
```go
package main
import "github.com/astaxie/beego"
func main(){
beego.Run()
}
```
2017-04-02 09:04:08 +00:00
#### Build and run
go build hello.go
./hello
2017-04-02 09:04:08 +00:00
#### Go to [http://localhost:8080](http://localhost:8080)
Congratulations! You've just built your first **beego** app.
###### Please see [Documentation](http://beego.me/docs) for more.
###### [beego-example](https://github.com/beego-dev/beego-example)
2020-06-29 13:53:52 +00:00
2013-06-22 11:17:50 +00:00
## Features
2012-12-16 15:43:42 +00:00
2013-12-22 07:56:15 +00:00
* RESTful support
2013-09-25 13:40:24 +00:00
* MVC architecture
2014-08-22 05:32:54 +00:00
* Modularity
* Auto API documents
* Annotation router
* Namespace
2015-02-02 14:33:59 +00:00
* Powerful development tools
2014-08-22 05:32:54 +00:00
* Full stack for Web & API
2013-06-22 11:17:50 +00:00
## Documentation
2014-08-22 05:32:54 +00:00
* [English](http://beego.me/docs/intro/)
* [中文文档](http://beego.me/docs/intro/)
* [Русский](http://beego.me/docs/intro/)
2012-12-16 15:43:42 +00:00
2014-08-22 05:32:54 +00:00
## Community
2012-12-17 05:33:32 +00:00
2014-08-22 05:32:54 +00:00
* [http://beego.me/community](http://beego.me/community)
2016-02-02 15:34:32 +00:00
* Welcome to join us in Slack: [https://beego.slack.com](https://beego.slack.com), you can get invited from [here](https://github.com/beego/beedoc/issues/232)
2019-10-10 03:23:19 +00:00
* QQ Group Group ID:523992905
2013-06-21 08:40:58 +00:00
2017-04-02 09:04:08 +00:00
## License
2013-06-22 11:17:50 +00:00
2016-01-13 14:20:34 +00:00
beego source code is licensed under the Apache Licence, Version 2.0
2014-08-22 05:32:54 +00:00
(http://www.apache.org/licenses/LICENSE-2.0.html).