Documentation
Everything lives here: install once, learn guide by guide, and keep the CLI reference nearby. Use the search (Ctrl K) to jump anywhere.
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, rate limiting and opt-in CORS.
Uploads
Multipart file uploads through params.
Console
Development console: boot banner, request log and slow-request highlighting.
Testing
Testing Altair applications with Altair::Test helpers.
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.