gopher

README

GOPHER

Advanced Golang Framework

Bases:

• Docker
• Microservices
• Mono Repository
• Standard Project Layout

Pre requirement

macOS:

brew install go
echo 'export GOPATH="$HOME/go"' >> ~/.zshrc
echo 'export PATH="$PATH:$(go env GOPATH)/bin"' >> ~/.zshrc
go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow@latest

brew install protobuf
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install github.com/favadi/protoc-go-inject-tag@latest
go install github.com/swaggo/swag/cmd/swag@latest
go install github.com/air-verse/air@latest

brew install --cask docker

Linux using apt:

wget "https://dl.google.com/go/$(curl -Ls https://go.dev/VERSION\?m\=text | head -n 1).linux-amd64.tar.gz"
tar -C /usr/local -xzf $(curl -Ls https://go.dev/VERSION\?m\=text | head -n 1).linux-amd64.tar.gz
echo 'export GOPATH="$HOME/go"' >> ~/.bashrc
echo 'export PATH=$PATH:$(go env GOPATH)/bin:/usr/local/go/bin"' >> ~/.bashrc
echo 'export PATH=$PATH:~/go/bin' >> ~/.bashrc
go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow@latest

apt install -y protobuf-compiler
apt install -y build-essential
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install github.com/favadi/protoc-go-inject-tag@latest
go install github.com/swaggo/swag/cmd/swag@latest
go install github.com/air-verse/air@latest

curl -fsSL get.docker.com -o get-docker.sh && sh get-docker.sh

Installation

go install github.com/mohsensamiei/gopher/v3/cmd/gopher@latest

How to use

• Creating project codebase: gopher init -r [REPOSITORY URL]
• Creating a new command: gopher cmd -n [COMMAND NAME]
• Creating a new migration: gopher migrate -c [COMMAND NAME] -n [MIGRATION NAME]
• Creating a new language: gopher lang -n [LANGUAGE ABBR]
• Downloading project dependencies: gopher dep
• Generating the project protobuf codes: gopher proto
• Formatting the project codes: gopher fmt
• Testing the project: gopher test
• Building the project: gopher build
• Build and running the project: gopher run
• Running the project: gopher up