Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.86 KB

File metadata and controls

51 lines (36 loc) · 1.86 KB

Hatmax Documentation

Hatmax is a composable Go toolkit for building web applications. The User Guide is the path from a first running process to an application that stores data, signs in, does work outside the request, and reads a runtime setting. Supporting guides explain focused tasks, package contracts, and the design decisions that connect the packages.

User Guide

The User Guide is the learning path. Follow it in order when building a first application, or open one chapter when returning to a step you already know.

Focused tutorials that are not part of the main learning path are listed in the Tutorials index.

How-to Guides

The How-to Guides are direct procedures for known goals, including application setup, Postgres, migrations, authentication, mail, background jobs, pubsub, image storage, and database-backed tests.

Reference

The Reference states exported contracts, options, errors, limits, and lifecycle behavior. Start with Terminology when a Hatmax name is unfamiliar.

Package readme.md files remain next to the code. They are implementation notes. They do not override exported code or the reference.

Explanation

The Explanation index describes component ordering, configuration boundaries, Postgres-first infrastructure, adapter ownership, server-rendered HTMX, and failure boundaries.

Additional Reference

  • Package Map summarizes the public package surface.
  • Gallery shows the example application.
  • The project changelog records release-worthy changes.