Go Cobra - Microservices Architecture

Go version: go 1.20

Directory structure

├── cmd
│   ├── root.go
│   ├── worker.go
│   ├── gapi.go
│   ├── client.go
│   ├── kafka-consumer.go
│   ├── kafka-producer.go
│   ├── public-api.go
├── config
│   ├── config.go
├── util
│   ├── random.go
├── db
│   ├── migrations
│   │   ├── example_schema.down.sql
│   │   ├── example_schema.up.sql
│   ├── queries
│   │   ├── example.sql
│   ├── sqlc
│   │   ├── ...
├── pkg
│   ├── grpc
│   │   ├── pb
│   │   │   ├── example.pb.go
│   │   │   ├── ...
│   │   ├── proto
│   │   │   ├── example.proto
│   │   │   ├── ...
│   │   ├── converter.go
│   │   ├── server.go
│   │   ├── example.go
│   ├── redis
│   │   ├── redis.go
│   ├── kafka
│   │   ├── consumer.go
│   │   ├── producer.go
│   │   ├── ...
│   ├── public-api
│   │   ├── server.go
│   │   ├── example.go
│   │   ├── ...
│   ├── worker
│   │   ├── distributor.go
│   │   ├── processor.go
│   │   ├── email_delivery.go
│   │   ├── ...
│
├── main.go
├── .env.example
├── Makefile
├── sqlc.yaml
├── Dockerfile
├── ...
...

Getting started

Install Dependencies

From the project root, run:

go build ./...
go mod tidy

• Run public api

 make public-api

• Run worker

make worker

Setup gRPC

# Macos
brew install protobuf

# I’ll make sure it’s installed:
protoc --version

# Install the protocol compiler plugins for Go using the following commands:
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28

# Update your PATH so that the protoc compiler can find the plugins:
export PATH="$PATH:$(go env GOPATH)/bin"

If you want to test if the methods in the service of gRPC are running, you can install BloomRPC Github to try or Home brew

For Docker

# Build image
docker build -t cobra-cmd .

Following a 12-factors model where environment variables are configured via the container's environment variables at runtime instead of injecting them into the code and building into an image.

Therefore, if you want to use the .env file in the container, you can mount the .env file in the container when starting the container.

# Serve public-api-cmd, with container name is public-api. And `public-api-cmd` will be an argument for ENTRYPOINT. We will expose port 8080 and map port 8088 from the host machine to port 8088 inside the container
# Exam: /app/cobra-cmd public-api-cmd
docker run --name public-api  -it -p 8088:8088 -v $(pwd)/.env:/app/.env cobra-cmd public-api-cmd

Happy Coding 🎉