Versions Compared

Old Version 20

changes.mady.by.user 王仁义

Saved on

compared with

New Version Current

changes.mady.by.user 王仁义

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

从v2版本开始，项目的创建不再依赖远端获取，仓库模板已经通过资源管理的方式内置到了工具二进制文件中，因此项目创建速度非常迅速。

使用方式

Code Block
languagexml
$ gf init -h 
USAGE
    gf init ARGUMENT [OPTION]

ARGUMENT
    NAME    name for the project. It will create a folder with项目名称，在当前目录下创建名为 NAME in的文件夹，并且 currentmodule directory.The NAME will also be the
            module name for the project.名称也为 NAME

OPTION
    -m, --mono    initialize a初始化大仓模式 mono-repo instead a single-repo
	-a, --monoApp initialize a初始化大仓下的一个小仓 mono-repo-app instead a single-repo
	-u, --update  update to the latest goframe version 初始化后使用最新的框架版本
	-g, --module  custom go自定义 module
     -h, --help    more information about this command更多帮助

EXAMPLE
    gf init my-project
    gf init my-mono-repo -m

我们可以使用init命令在当前目录生成一个示例的GoFrame空框架项目，并可给定项目名称参数。生成的项目目录结构仅供参考，根据业务项目具体情况可自行调整。生成的目录结构请参考 代码分层设计 章节。

Info

GoFrame框架开发推荐统一使用官方的go module特性进行依赖包管理，因此空项目根目录下也有一个go.mod文件。


Tip

工程目录采用了通用化的设计，实际项目中可以根据项目需要适当增减模板给定的目录。例如，没有kubernetes部署需求的场景，直接删除对应deploy目录即可。

使用示例

在当前目录下初始化项目

Code Block
languagexml
$ gf init .
initializing...
initialization done!
you can now run 'gf run main.go' to start your journey, enjoy!

创建一个指定名称的项目

Code Block
languagexml
$ gf init myapp
initializing...
initialization done!
you can now run 'cd myapp && gf run main.go' to start your journey, enjoy!

创建一个MonoRepo项目

默认情况下创建的是SingleRepo项目，若有需要也可以创建一个MonoRepo（大仓）项目，通过使用-m选项即可。

Code Block
languagexml
$ gf init mymono -m
initializing...
initialization done!

关于大仓的介绍请参考章节：微服务大仓管理模式

创建一个MonoRepoApp项目

若需要在MonoRepo（大仓）下的创建一个小仓，通过使用-a选项即可。

Code Block
languagexml
$ gf init app/user -a
initializing...
initialization done!


Panel
titleContent Menu

Table of Contents


...