How to add a new API endpoint in Modern Go Application?

Follow the existing package structure in the boilerplate, typically under an internal or app directory, and integrate with the routing setup. You'll need to update configuration and possibly telemetry handlers to ensure consistency with the project's patterns.

Modern Go Application vs Go Kit for microservices

Modern Go Application is a boilerplate focusing on integrated tools and best practices for general applications, while Go Kit is a framework specifically for microservices with more abstractions. Choose Modern Go Application for a ready-to-use template, or Go Kit if you need a dedicated microservices toolkit with stricter separation of concerns.

Does Modern Go Application work with Docker and Kubernetes?

Yes, it includes examples and configurations for Docker, and features like health checks and graceful shutdown make it well-suited for Kubernetes deployments. Refer to the README sections on running the application for guidance.

How to replace MySQL with PostgreSQL in this boilerplate?

You would need to swap the go-sql-driver/mysql dependency for a PostgreSQL driver like lib/pq, update database connection logic in the code, and adjust configuration settings. This requires manual changes as the boilerplate is optimized for MySQL.

Can I use Modern Go Application for a CLI tool?

While possible, it's overkill due to its focus on server-side features like telemetry and health checks. For CLI tools, a lighter template or minimal setup would be more efficient unless you need advanced logging or configuration management.

How to disable telemetry if not needed?

You can remove or comment out the OpenCensus integrations in the code and configuration files, but this requires careful editing to avoid breaking other dependencies, as the boilerplate tightly couples these features.

Open-Awesome

modern-go-application

MITGo

A Go application boilerplate and example implementing modern development practices like configuration, logging, telemetry, and graceful shutdown.

GitHub

1.9k stars179 forks0 contributors

What is modern-go-application?

Modern Go Application is a boilerplate and example project that demonstrates best practices for building production-ready applications in Go. It provides a structured foundation covering configuration, logging, error handling, telemetry, and deployment, helping developers avoid common pitfalls and follow modern standards.

Target Audience

Go developers and teams starting new projects who want a production-tested template with integrated tools for configuration, observability, and maintainability.

Value Proposition

It consolidates widely-adopted libraries and patterns into a single, coherent example, reducing setup time and ensuring applications are built with robust, scalable practices from the start.

Overview

Modern Go Application example

Use Cases

Best For

Starting new Go microservices or web applications with a production-ready foundation
Learning modern Go application architecture and best practices
Implementing structured logging and error handling in Go projects
Adding metrics, tracing, and health checks to existing Go applications
Building event-driven applications with messaging support
Creating applications that require graceful shutdown and zero-downtime deployments

Not Ideal For

Quick prototypes or MVPs where extensive production tooling adds unnecessary overhead
Projects aiming for minimal dependencies and a lightweight, vendor-agnostic codebase
Applications requiring different core technologies like PostgreSQL, MongoDB, or Kafka not natively supported

Pros & Cons

Pros

Integrated Best Practices

Packages modern Go libraries like Viper for configuration and Logur/Logrus for logging, providing a cohesive foundation that reduces setup time and enforces consistency.

Production Observability

Includes Prometheus for metrics and Jaeger for distributed tracing via OpenCensus, essential for monitoring and debugging in scalable environments.

Reliability Features

Implements health checks with go-sundheit and graceful shutdown with tableflip, ensuring application stability and zero-downtime deployments as highlighted in the README.

Event-Driven Support

Integrates Watermill for messaging, enabling building decoupled, scalable applications without needing to set up event handling from scratch.

Cons

Heavy Dependency Footprint

Includes numerous third-party libraries that can lead to bloat, increased complexity, and potential version conflicts for simpler use cases.

Opinionated Library Choices

Locks you into specific tools like Viper and Logrus, making it harder to switch to alternatives or customize without significant refactoring.

Setup and Maintenance Overhead

The init script helps, but customizing components (e.g., replacing MySQL) requires deep diving into integrated code, which can be time-consuming and error-prone.

Frequently Asked Questions

Related Projects

project-layout

Standard Go Project Layout

Stars56,080

Forks5,443

Last commit1 month ago

go-blueprint

Go-blueprint allows users to spin up a quick Go project using a popular framework

Stars8,848

Forks486