Documentation

The Altair documentation, generated from markdown. All content lives in website/pages/.

Getting started

• Install — download and set up Altair on Linux, macOS or Windows.
• Usage — create a project, generate a scaffold and run the server.
• Updating — keep the altair binary and a project's framework copy current.

Guides

• Routing — routes, parameters, resources, helpers and redirects.
• Controllers — actions, typed parameters, rendering and templates.
• Views — ECR templates, escaping, layouts, partials, helpers and the form builder.
• Record (ORM) — models, migrations, validations, callbacks and associations.
• Sessions and auth — signed-cookie sessions, flash, CSRF and login helpers.
• Configuration — .env, config/database.yml and typed per-environment settings.
• Security — default headers, request ids and opt-in CORS.
• Uploads — multipart file uploads through params.

Reference

• What is implemented — the current state of the framework, phase by phase.
• CLI reference — every command and generator.
• Benchmarks — Altair vs Express and Fiber under real HTTP load.

Contribute

Altair is open source. Source code, issues and releases live on GitHub.