Skip to content
Docs

Docs

This is the documentation for Salusa, an open source web framework for Go. The pages are grouped roughly the way you meet them in a real project, so the usual path through them is top to bottom — but every page stands on its own, and each package can be imported on its own if you only need one piece of the framework.

If you have never used Salusa before, start with Getting Started: it creates a project with the spice CLI and walks through the directory layout.

Start here

Getting Started
Create a project, run the dev server, and learn the layout
Spice CLI
Project scaffolding, the dev server, and code generation

The core

The pieces every application uses: the kernel that boots and runs services, the container that fills in your dependencies, and the HTTP layer on top.

Application & Kernel
Boot the app, validate dependencies, and run long-lived services
Dependency Injection
Register providers and resolve them with inject tags
Configuration & Environment
Read typed config out of environment variables
Routing
Middleware pipelines, named routes, and URL generation
Requests & Responses
Bind requests to typed structs and serialize typed JSON
Views
Server-side HTML templates with layouts and route helpers

Data

Models, queries, and the value types that move between your database, your handlers, and your API.

Database
Models, relationships, a query builder, and migrations
Option Values
Absent and nullable values with option.Option[T]
Maps & Sets
Generic collections built on Go iterators
JSON I/O
Expose Go values as io.Reader and io.Writer
Caching
Key-value caches for transient data

Services

The things your app does beyond serving requests.

Authentication
JWT login, signup, password resets, and email verification
Files & File Serving
File storage abstractions and static assets with SPA fallback
Events
Dispatch events to synchronous and asynchronous listeners
Queueing
Message queues with in-memory and database-backed drivers
Email
Send HTML and plain-text mail over SMTP

Day to day

Logging
Structured logging with clog and log/slog
Errors & Stack Traces
Create errors that keep the stack trace of their origin
Streams
Lazy, chainable sequences over iter.Seq[T]
OpenAPI & ReDoc
Generate a spec from your Go types and serve ReDoc
Testing
Test handlers, routes, and the kernel itself

Changelog

User-facing changes in each release are collected on the release notes page, newest first.

Getting Started