Getting Started

This guide will help you get started with Humus, from installation to building your first service.

Prerequisites

Before you begin, ensure you have:

• Go 1.21 or later installed on your system
• Basic familiarity with Go programming
• Understanding of REST APIs, gRPC, or batch processing (depending on your use case)

What You’ll Learn

This section covers:

• Installation - Installing Humus and setting up your environment
• Your First Service - Building a Hello World REST service
• Configuration - Understanding the YAML configuration system
• Project Structure - Recommended project layout patterns

Quick Start

If you want to jump right in:

# Install Humus
go get github.com/z5labs/humus

# Create a new project
mkdir my-service && cd my-service
go mod init my-service

Then follow the First Service guide to build your first application.

Next Steps

Once you’re comfortable with the basics, explore:

• Core Concepts - Understand Humus architecture
• REST Services - Build HTTP APIs
• gRPC Services - Build gRPC microservices
• Job Services - Build batch processors