User Guide

Comprehensive guides covering core framework functionality including database ORM, schema migrations, form processing, security, authentication, reactive components, WebSockets, background tasks, and internationalization.

• ORM Basics
  • Define a model
  • Schema Evolution & Migrations
  • Field types
  • Database Engines & Drivers
  • CRUD
  • Query builder
  • Relationships
  • Soft delete
  • File fields
  • Lifecycle hooks
  • Pagination
  • Password hashing
  • Encrypted fields
  • Slug auto-generation
  • Serialization
  • Performance
• Advanced ORM Features
  • 1. Advanced Field Types
  • 12. SQLite High-Concurrency & WAL Concurrency Optimizations
  • 13. Slow Query Alerting & Profiling
  • 14. Safe Model Updates & Query Ordering Fallbacks
  • 2. Advanced Querying
  • 3. Native Vector Search (Semantic)
  • 4. High-Performance Model Methods
  • 5. Nested Eager Loading
  • 6. Polymorphic Relationships
  • 7. Generic Global Scopes
  • 8. Savepoint-Based Nested Transactions
  • 9. PostgreSQL Connection Pooling
  • 10. Database Fixtures (Backup & Restore)
  • 11. Transparent Multi-Language Support
  • 12. Multiple Database Connections
  • SaaS Multi-Tenancy (Database & Schema Isolation)
• Database Migrations
  • 1. Concept
  • 2. Generating Migrations
  • 3. Applying Migrations
  • 4. Checking Status
  • 5. Rolling Back & Target Migrations
  • 6. Advanced Options
  • 7. Production Workflow (Best Practices)
• Forms
  • Basic usage
  • Form constructor
  • Generated HTML
  • Render parts separately
  • Custom classes (Tailwind, etc.)
  • CSRF & Hidden Fields Shortcuts
  • Field types
  • Advanced Form Fields (v0.1.4+)
  • Generate a form from a Model
  • Translating labels (i18n)
  • Custom error messages
  • Pre-filling for edit forms
  • Accessing values after POST
  • Checking errors
  • Reset form
  • Reusable forms (newsletter, search, etc.)
  • Partial update (no full page reload)
  • Client-Side Live Validation with Asok Directives
• Advanced Forms Features
  • 1. Modern HTML5 Fields
  • 2. ORM Integration
  • 3. Automated Model Forms
  • 4. Custom Validation Rules
• Form Actions
  • The action_[name] Convention
  • Why use Form Actions?
  • Example: Create a Post
  • Multiple Actions in one Page
  • Using data-action (Recommended for AJAX)
  • Multiple Forms on one Page
  • Best Practices
  • Common Patterns
  • Technical Details
• Validation
  • With Form (recommended)
  • Standalone usage
  • Manual Error Injection
  • Available rules
  • Combining rules
  • Custom error messages
  • Password confirmation
  • File validation
  • Database uniqueness
  • i18n
  • Custom rules
• Serialization (Schema)
  • Basic Example
  • Collections (many=True)
  • Auto-formatting
  • Why use Schemas instead of to_dict()?
  • Integration with API Responses
  • Request Context
• File Storage
  • UploadedFile
  • MIME Type Validation
  • Serving Files
  • Configuration
• Authentication
  • Setup
  • Protecting pages
  • Current user
  • How It Works
  • Configuration
  • 5. Magic Links in Production (Fail-Secure Requirements)
• Advanced Authentication
  • 1. Magic Links (Passwordless)
  • 2. OAuth2 (Social Login)
  • 3. API Tokens (Bearer Auth)
  • 4. Roles & Permissions (RBAC)
  • 5. Two-Factor Authentication (2FA)
  • 6. Security Notes
• Sessions
  • Usage
  • Configuration
  • Cookie Security
  • How it works
  • Session API
  • Production Persistence
• Security Headers
  • Default headers
  • Configuration
• CORS & Gzip
  • CORS (Cross-Origin Resource Sharing)
  • Gzip Compression
  • ETags (Caching)
• Rate Limit
  • Quick Start (Decorator)
  • Limit Syntax
  • Global Middleware
  • 4. Production Storage (Shared Limit)
  • Programmatic Rate Limiting (Custom Responses)
  • 5. Options
• Reactive Components
  • Overview
  • Basic Example
  • Exposing Methods
  • How it Works
  • The “Alive” Reactive Engine
  • Islands Architecture & Selective Hydration
  • Real-time Model Subscriptions (data-subscribe)
  • Automatic State Persistence
  • Persistent Sessions
  • Accessing the current request inside a component
• Transitions
  • Overview
  • Usage
  • Page Transitions (SPA Router Navigation)
  • How it Works
  • WebSocket Support
  • Professional Easing Curves
  • CSS Customization
  • Performance Tips
  • Comparison with SvelteKit
• WebSockets
  • Setup
  • Security
  • Production Setup
  • Handlers
  • Advanced Features
  • The Connection Object
  • Broadcasting
  • Authentication
  • Multi-Server Scaling & Redis Pub/Sub Cluster Adapter
  • Deployment (Nginx)
  • Frontend: window.asokWS(path)
  • 8. Non-Browser Clients & Missing Origin Headers
  • 9. Production Error Sanitization in Live Components
• Email Service
  • Configuration
  • Send an email
  • HTML email
  • Multiple recipients
  • CC and BCC
  • Custom sender
  • Usage in a page
  • Background vs synchronous
• Caching
  • 1. Template Fragment Caching
  • 2. Caching HTTP Pages
  • 2. Caching Database Queries
  • 3. Global Configuration
  • Advanced Usage (Manual Caching)
• Background Tasks
  • Usage
  • 2. Configuration & Backends
  • 3. Standalone Usage
  • Error handling & Job Tracking
  • Common use cases
  • Mail is already background
  • When NOT to use background
  • Context propagation: current_request in background tasks
  • Retries, Exponential Backoff & Jitter
  • Dead Letter Queue (DLQ)
• Scheduled Tasks
  • Quick Start
  • 2. Timing Syntax
  • 3. Standalone Usage
  • 4. Error Handling
  • 5. Production & Multi-Process Environments
• Internationalization (i18n)
  • Setup
  • Usage in templates
  • Usage in Python
  • Language detection
  • Current language
  • Language switcher
  • Dynamic values
  • Missing keys
  • Translating forms
  • Translating models (Database)
  • Default language