go-graphql

go-graphql

The go-graphql project is a dynamic, open-source Golang 💻 repository that serves as a modern blueprint for building scalable, clean, and production-ready web services 🚀. It showcases best practices in architecture by strictly adhering to Clean Architecture 🏗️ and domain-centric modularity, organizing code into distinct layers (controllers, services, and repositories) to ensure the application is highly maintainable ✅ and easily testable 🧪 as it grows.

---

✨ Key Architectural Features

• Dependency Management: Uses Uber FX ✨ for robust dependency injection and graceful application lifecycle management.
• Web Framework: Leverages the Gin framework 🌐 for a high-performance HTTP layer.
• Data Access: Utilizes SQLC 💾 for type-safe interaction with the database.
• Performance: Integrates a Redis-backed cache layer 🧠 for speed and efficiency.
• Communication: Includes a gRPC server ⚡ to demonstrate high-performance microservice communication.
• Core Module: Features a fully functional Product Management Module 📦 with complete CRUD (Create, Read, Update, Delete) functionality.

---

📚 Documentation & Learning

This repository is an evolving guide to advanced Go development. All architectural decisions and feature implementations are thoroughly documented through a series of dedicated articles on Medium. By following this project, you can learn essential advanced Go idioms, master the use of DTOs (Data Transfer Objects) 💼, and implement professional-grade backend systems 💡.

medium.com/list/gosimple-b350f5c3bdb6

Run project

go run cmd/server/main.go

Swagger address

http://127.0.0.1:4000/swagger/index.html#/

Generate Swagger Documentation

swag init --parseDependency --parseInternal -g cmd/server/main.go

Run docker compose

docker compose up -d

SQLC Generator

go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest

sqlc generate

Run tests

go test ./test/server_test.go

Run Sonar

docker run --name sonarqube \
  -p 9000:9000 \
  sonarqube:latest


go test -coverpkg=./... -coverprofile=coverage.out ./test
go test -v ./test | grep FAIL
go test ./... -json > report.json

go tool cover -func=coverage.out

Add sonar test

sonar-scanner \
  -Dsonar.projectKey=go-graphql \
  -Dsonar.sources=. \
  -Dsonar.host.url=http://127.0.0.1:9000 \
  -Dsonar.token=sqp_XXXX

export SONAR_HOST_URL=http://your-sonarqube-server.com
export SONAR_TOKEN=your-sonar-token-here

Run project

docker compose up
go run cmd/server/main.go

GraphQL

go install github.com/99designs/gqlgen@latest
gqlgen init
gqlgen generate

build new query

gqlgen generate
add sql in sqlc
sqlc generate

-- name: ListProductsWithFilters :many
SELECT id, product_name, product_description, price, is_active, created_at
FROM products
WHERE
  (sqlc.narg('id')::int IS NULL OR id = sqlc.narg('id'))
  AND (sqlc.narg('product_name')::text IS NULL OR product_name ILIKE '%' || sqlc.narg('product_name') || '%')
  AND (sqlc.narg('min_price')::bigint IS NULL OR price >= sqlc.narg('min_price'))
  AND (sqlc.narg('max_price')::bigint IS NULL OR price <= sqlc.narg('max_price'))
  AND (sqlc.narg('is_active')::bool IS NULL OR is_active = sqlc.narg('is_active'))
  AND (sqlc.narg('product_description')::text IS NULL OR product_description ILIKE '%' || sqlc.narg('product_description') || '%')
ORDER BY id
LIMIT sqlc.narg('limit')
OFFSET sqlc.narg('offset');

query {
  products(filter: { id: 32 }) {
    products {
      id
      name
      description
      price
      isActive
    }
    total
  }
}