Go Language: Basic Project Workflow with Modules

Go (often referred to as Golang) is an open-source programming language designed for building simple, reliable, and efficient software. Go modules are the unit of source code interchange and versioning in Go. They allow you to organize your code, manage dependencies, and ensure reproducible builds. This document outlines the basic steps for starting a new Go project using modules, building it, and running the resulting executable.

1. Initialize a New Go Module (go mod init)

Before writing any Go code, you should initialize your project as a Go module. This creates a go.mod file, which tracks your project’s dependencies.

go mod init <module-path>
# Example: If your project will be hosted on GitHub
go mod init github.com/<your-username>/<your-project-name>
# Example: For a simple local project
go mod init myproject

• go mod init: Initializes a new module.
• <module-path>: The module path is often the repository URL where your code will be hosted, or a unique name for local development.

2. Write Your Go Code

Create your Go source files (e.g., main.go) within your project directory.

Example: main.go

package main
 
import "fmt"
 
func main() {
    fmt.Println("Hello, Go Modules!")
}

3. Build Your Project (go build)

The go build command compiles your Go source files and packages into an executable binary.

go build <package-path>
# Example: Build the main package in the current directory
go build .
# Example: Build a specific file
go build main.go
# Example: Build a package in a subdirectory
go build cmd/my-app

By default, go build creates an executable with the same name as the directory it’s run in (if building a package) or the name of the main source file (if building a single file).

You can specify the output executable name using the -o flag:

go build -o myapp main.go

4. Run the Executable

After building, you can run the generated executable directly.

./<executable-name>
# Example (if you built 'main.go' in the current directory, the executable might be 'main' or the directory name):
./main
# Example (if you used 'go build -o myapp main.go'):
./myapp

5. Compile and Run Simultaneously (go run)

For quickly testing single Go source files or packages, go run compiles and runs the program in a single step, without producing an intermediate executable file.

go run <package-path_or_file>
# Example:
go run main.go

This is convenient for development and testing, as it avoids managing temporary executable files.