tip

Starting from version v2, project creation no longer relies on remote retrieval. The repository templates are embedded into the tool’s binary files via Resource, making project creation very fast.

Usage

$ gf init -h
USAGE
    gf init ARGUMENT [OPTION]
ARGUMENT
    NAME    The project name, creating a folder named NAME in the current directory, and the module name will also be NAME
OPTION
    -m, --mono    Initialize monorepo mode
    -a, --monoApp Initialize a small repository under monorepo
    -u, --update  Use the latest framework version after initialization
    -g, --module  Customize module
    -h, --help    More help
EXAMPLE
    gf init my-project
    gf init my-mono-repo -m

We can use the init command to generate a sample GoFrame empty framework project in the current directory and provide a project name parameter. The generated project directory structure is for reference only and can be adjusted according to the specific situation of the business project. For the generated directory structure, please refer to the Code Layering section.

note

The GoFrame framework development recommends the unified use of the official go module feature for dependency package management, so there is also a go.mod file in the root directory of the empty project.

tip

The project directory uses a generalized design, and in actual projects, you can increase or decrease the directories given by the template as needed. For example, in scenarios where there is no need for kubernetes deployment, simply delete the corresponding deploy directory.

Examples of Use

Initialize a project in the current directory

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

Create a project with a specified name

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

Create a MonoRepo project

By default, a SingleRepo project is created, but if needed, you can also create a MonoRepo project by using the -m option.

$ gf init mymono -m
initializing...
initialization done!

For an introduction to monorepos, please refer to the section: Mono-Repo Management

Create a MonoRepoApp project

If you need to create a small repository under a MonoRepo, specify the project path to be generated in the root directory of the repository project and use the -a option.

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