Quick Start

First make sure you have GO installed, version 1.16 or higher, and that you have set the GOPATH environment variable and added GOPATH/bin to the environment variable.

We recommend that you simply use the latest stable version, as we try to stay on top of the latest version of Go.

Or you can refer:

Windows installation

Linux installation

Mac installation

Please note that after Beego V2 we require the go mod feature. Make sure that the go mod feature is turned on, i.e. GO111MODULE=on. For more details, please refer to Go module.

Or you can specify the GOPROXY:

GOPROXY=https://goproxy.cn

Next, let's try to start a hello world example. In this example, we will use the bee tool to create the hello world project.

For more details, please refer to bee

Steps

If you already have a development environment installed, then you may consider using our quick install script.

Mac or Linux

Run:

bash <(curl -s https://raw.githubusercontent.com/beego/beego-doc/main/scripts/quickstart.sh)

Or using wget:

bash <(wget -qO- https://raw.githubusercontent.com/beego/beego-doc/main/scripts/quickstart.sh)

Windows

Using curl：

bash <(curl -s https://raw.githubusercontent.com/beego/beego-doc/main/scripts/quickstart.bat)

Or wget:

bash <(wget -qO- https://raw.githubusercontent.com/beego/beego-doc/main/scripts/quickstart.bat)

Manual Installation

In this section, we will use the go get command, so if you are not familiar with it, we suggest that you read more about go get.

Always remember, if you experience network problems or timeout issues, make sure you set up the GOPROXY proxy.

Install Bee

Run:

go get -u github.com/beego/bee/v2@latest

For Go 1.18 and newer Go versions run:

go install github.com/beego/bee/v2@latest

And then:

bee version

Now you can see:

| ___ \
| |_/ /  ___   ___
| ___ \ / _ \ / _ \
| |_/ /|  __/|  __/
\____/  \___| \___| v2.0.x

├── Beego     : Beego is not installed. Please do consider installing it first: https://github.com/beego/beego/v2. If you are using go mod, and you don't install the beego under $GOPATH/src/github.com/beego, just ignore this.
├── GoVersion : go1.16
├── GOOS      : linux
├── GOARCH    : amd64
├── NumCPU    : 12
├── GOPATH    : /home/xxx/go
├── GOROOT    : /home/aaa/bbb/go
├── Compiler  : gc
└── Published : 2020-12-16

Create Project

Run:

bee new hello
cd hello
go mod tidy

And then:

bee run

Now you can see:

2021/03/31 23:29:19 SUCCESS  ▶ 0004 Built Successfully!
2021/03/31 23:29:19 INFO     ▶ 0005 Restarting 'hello'...
2021/03/31 23:29:19 SUCCESS  ▶ 0006 './hello' is running...
2021/03/31 23:29:22.016 [I] [parser.go:413]  generate router from comments

2021/03/31 23:29:22.016 [I] [server.go:241]  http server Running on http://:8080