Skip to content

安装

您可以通过以下命令安装 Nunu:

bash
go install github.com/go-nunu/nunu@latest

国内用户可以使用GOPROXY加速go install

$ go env -w GO111MODULE=on
$ go env -w GOPROXY=https://goproxy.cn,direct

tips: 如果go install成功,却提示找不到nunu命令,这是因为环境变量没有配置,可以把 GOBIN 目录配置到环境变量中即可

创建新项目

您可以使用以下命令创建一个新的 Golang 项目:

bash
nunu new projectName

// 推荐新用户选择Advanced Layout

此命令将创建一个名为 projectName 的目录,并在其中生成一个优雅的 Golang 项目结构。

国内加速源:

nunu new默认拉取github源,你也可以使用国内加速仓库

// 使用高级模板(推荐)
nunu new projectName -r https://gitee.com/go-nunu/nunu-layout-advanced.git

// 使用基础模板
nunu new projectName -r https://gitee.com/go-nunu/nunu-layout-basic.git

Nunu内置了两种类型的Layout:

  • 基础模板(Basic Layout)

    Basic Layout 包含一个非常精简的架构目录结构,适合非常熟悉Nunu项目的开发者使用。

  • 高级模板(Advanced Layout)

    Advanced Layout 包含了很多Nunu的用法示例( db、redis、 jwt、 cron、 migration等),适合开发者快速学习了解Nunu的架构思想。

    建议:我们推荐新手优先选择使用Advanced Layout。

启动服务

创建好项目之后,我们进入项目执行nunu run命令即可启动服务。

nunu run cmd/server/main.go

随后打开浏览器访问http://localhost:8080即可看到欢迎页面。

API文档地址: http://127.0.0.1:8000/swagger/index.html

Released under the MIT License.