Development Guide¶

Guides for developers working with HexaGo-generated projects.

Overview¶

This section covers practical guidance for working with projects generated by HexaGo. Whether you're building a new service, adding features, or debugging issues, these guides will help you navigate the codebase effectively.

Contents¶

Getting Started¶

Build and Run — Compile, test, and run your application
Configuration — Config file format and environment variables

Code Quality¶

Coding Conventions — Standard patterns for error handling, logging, and context usage
Testing — Unit tests, integration tests, and test organization

Architecture¶

Hexagonal Architecture — Dependency rules, layer structure, and port patterns

Developer Tools¶

Debugging & Profiling — Debugging, pprof, and benchmark commands

Quick Reference¶

# Build and test
make build && make test

# Run the application
go run main.go run

# Validate architecture
hexago validate

# Run linter
make lint

Prerequisites¶

Go 1.21 or later
For integration tests: API keys configured in .env
For Docker: Docker and Docker Compose installed