Documentation
Welcome to the Flaxon documentation. Use the sidebar to navigate through the guides, core concepts, API reference, and examples.
Start with the Quick Start guide to build your first application in minutes.
Use the small Flaxon playground to inspect registered routes in your browser, then run the same code locally with flaxon run app:app --reload.
Getting Started
Get up and running with Flaxon quickly.
Installation
Install Flaxon via pip with optional dependencies.
Learn more →Quick Start
Build your first Flaxon application in minutes.
Learn more →Philosophy
Understand the principles behind Flaxon.
Learn more →Core Concepts
Learn the fundamental building blocks of Flaxon.
Routing
Define routes with Flask-style decorators and path parameters.
Learn more →Requests
Access headers, cookies, query params, and request bodies.
Learn more →Responses
Return JSON, HTML, text, redirects, and streaming responses.
Learn more →Middleware
Add cross-cutting concerns like CORS, logging, and rate limiting.
Learn more →Validation
Declarative schemas with automatic 422 responses.
Learn more →Guides
Deep dives into specific Flaxon features and integrations.
Databases
Connect to PostgreSQL, SQLite, MongoDB, and more.
Learn more →Authentication
JWT, session, OAuth2, and API key authentication.
Learn more →Authorization
Role-based and permission-based access control.
Learn more →WebSockets
Real-time communication with room broadcasting.
Learn more →Tasks
Background job processing with retries and scheduling.
Learn more →Jinax Templates
Optional Jinja2 integration for HTML rendering.
Learn more →Testing
Test your application with sync and async test clients.
Learn more →Debugging
Readable error messages with request context and suggestions.
Learn more →Plugins
Extend Flaxon with modular plugins.
Learn more →Ecosystem
Use SQLAlchemy, Stripe, S3, and PostgreSQL integrations.
View integrations →Mobile Backends
Optimized for Android, iOS, and Flutter applications.
Learn more →API Reference
Complete API documentation for Flaxon classes and methods.
Application
Flaxon class, Config, and State.
View API →Routing
Router, Route, and URL generation.
View API →HTTP
Request, Response, Headers, and Cookies.
View API →WebSocket
WebSocket, Manager, and connection handling.
View API →Validation
Schema, Fields, and Validators.
View API →Security
JWT, Sessions, CSRF, and Rate Limiting.
View API →Jinax
Template engine, filters, and functions.
View API →Tasks
Task, Queue, Worker, and Scheduler.
View API →Testing
TestClient, Assertions, and fixtures.
View API →Platform Guides
Build complete applications with Flaxon's Admin, CMS, email, templates, and frontend tooling. The latest Jinax, mobile, Teloce-Py, and VS Code guides are now available below.
Admin and CMS
Authenticated models, content workflows, media, and APIs.
Modules
Compose industrial applications with reusable domains and fast development workflows.
Production Case Study
Build a real organization site with Flaxon, Jinax, Admin, CMS, and production services.
Console testing, SMTP, templates, and attachments.
Teloce-Py
Compile .vel components and mount them in Flaxon.
Jinax App Starter
Build a server-rendered Flaxon application from scratch.
APK and Play Store
Connect an Android client to Flaxon and ship an AAB.
Teloce Android
Use .vel components in a Capacitor Android wrapper.
Flaxon Cheatsheet
Routes, middleware, data, operations, and CLI commands.
Teloce Cheatsheet
.vel syntax, compiler commands, and framework integration.
VS Code Extension
Project workflows and Flaxon CLI integration.
Examples
Real-world examples demonstrating Flaxon in action.
Basic API
RESTful CRUD operations with validation.
View Example →React Backend
CORS-enabled API for React applications.
View Example →Android Backend
Mobile-optimized API with JWT authentication.
View Example →WebSocket Chat
Real-time chat with room broadcasting.
View Example →Jinax Website
Server-rendered HTML with Jinax templates.
View Example →Large Application
Structured app with routers, services, and repositories.
View Example →