██████╗ ███████╗███╗   ██╗       ██████╗ 
	██╔════╝ ██╔════╝████╗  ██║      ██╔════╝ 
	██║  ███╗█████╗  ██╔██╗ ██║█████╗██║  ███╗
	██║   ██║██╔══╝  ██║╚██╗██║╚════╝██║   ██║
	╚██████╔╝███████╗██║ ╚████║      ╚██████╔╝
	 ╚═════╝ ╚══════╝╚═╝  ╚═══╝       ╚═════╝ 

gen-g Documentation

Fullform: Generate Golang Project

Introduction

• Inspired by Nest CLI geng is command-line interface tool that helps you to initialize, develop, and maintain your Go gin applications
• By default it will generate the clean code architecture of wesionaryTEAM

Installation

• Pre-requisite: You need to install the golang in your system: golang installation

go install github.com/mukezhz/geng@latest

Alternative Install

• Download and execute binary by downloading from assets

Add binary dir to your PATH variable [If geng command didn’t work after installation]

// For zsh: [Open.zshrc] & For bash: [Open .bashrc]
// Add the following:
export GO_HOME="$HOME/go"
export PATH="$PATH:$GO_HOME/bin"

// For fish: [Open config.fish]
// Add the following:
fish_add_path -aP $HOME/go/bin

Basic workflow

• Get help

geng help

• Create a new project

geng new <project-name> -m <project-module-name> [-d <directory>]

• Use Interactive to create new project

geng new

• Start project

cd <directory>
cp .env.example .env
go mod tidy

go run main.go

• Generate module in already existing project

// Project needs to initialize git repository to work module generation
geng gen module <module-name>

NOTE: default supported version is of golang 1.20

Diagrams

Thank You!!!