go-skeleton

README

GoSkeleton

GoSkeleton is a structured and scalable Go project template with built-in support for gRPC, HTTP, Swagger, telemetry, circuit breakers, rate limiting, and export utilities. It provides a clean foundation for developing production-ready applications.

       

Features

• gRPC & HTTP Support – Fully integrated gRPC and RESTful HTTP APIs.
• Swagger API Documentation – Automatically generated API docs with Swagger UI.
• Telemetry (Tracing & Metrics) – OpenTelemetry support for monitoring and observability.
• Circuit Breaker – Built-in resilience patterns to handle failures gracefully.
• Rate Limiting – Prevents abuse with request throttling mechanisms.
• Export Utilities – Includes Makefile commands for running and managing the application.
• Docker Support – Easily deployable using docker-compose.
• Security & Code Quality – Integrated linters and security scanners.

---

Getting Started

Prerequisites

• Go 1.16+
• buf (for Protocol Buffers)
• Docker (for containerized deployments)
• Make (for running commands efficiently)

---

Installation

1. Clone the repository

   git clone https://github.com/tolgaOzen/go-skeleton.git
   cd go-skeleton
   

2. Install dependencies

   go mod tidy
   

3. Run the application

   go run cmd/skeleton/skeleton.go
   

4. Run with Docker

   docker-compose up --build
   

---

Project Structure

go-skeleton/
├── cmd/skeleton       # Main application entry point
├── config             # Configuration files
├── internal           # Private application logic and business rules
├── pkg               # Reusable utilities and helpers
├── proto             # gRPC Protocol Buffers definitions
├── docs              # Swagger documentation & OpenAPI specs
├── tools             # Developer tools (linting, security scans, etc.)
└── Makefile          # Helpful automation commands

---

API Documentation

Swagger UI is available at:

http://localhost:8080/swagger/index.html

---

Observability

• Tracing – OpenTelemetry integration for distributed tracing.
• Metrics – Prometheus-compatible metrics for monitoring.

---

Makefile Commands

GoSkeleton includes export utilities via Makefile to streamline development.

Usage

make help

Available Commands

Command	Description
make build	Build the Go application
make format	Format code using gofumpt
make lint-all	Run all linters (golangci-lint, hadolint)
make security-scan	Scan for security vulnerabilities using gosec
make coverage	Generate global code coverage report
make clean	Remove temporary and generated files
make release	Prepare for release (format, scan, clean)
make serve	Run the compiled Go application
make compose-up	Start the application using docker-compose
make compose-down	Stop all docker-compose services

---

License

This project is licensed under the MIT License. See the LICENSE file for details.

For more details, visit the GoSkeleton GitHub repository.