RxDjango documentation

RxDjango is a layer over Django Channels and Django REST Framework aimed to make it as simple as possible to integrate backend and frontend, with performance and minimal latency. On the frontend side, it supports the React framework now, and adapters to other frontend frameworks can be implemented.

Contents:

• Quickstart
  • Install RxDjango
  • Configure ASGI and Redis
  • Configure MongoDB for Caching
  • Configure Frontend Code Generation
  • Create a ContextChannel
  • Set Up WebSocket Routing
  • Generate Frontend Files
  • Install RxDjango on the Frontend
  • Connect the Frontend State
• Architecture Overview
  • Key Architectural Principles
  • How It Works
  • Transaction-Aware Broadcasting
  • Authentication
• Using RxDjango
  • Backend
  • Frontend
  • Actions
  • Consumers
  • Runtime State
  • Important Constraints
• The ContextChannel class
  • Single instance channels
  • Multiple instance channels
  • Meta class
  • RuntimeState class
  • Methods
  • Write Authorization Methods
  • Class Methods
  • Serializer Meta Options
• Optimistic Updates
  • Overview
  • Backend Setup
  • Execution Flow
  • Frontend Usage
  • Rollback Behavior
  • Temporary IDs
  • Error Handling
  • WebSocket Protocol
  • Best Practices
  • Example: Complete Channel
• makefrontend CLI
  • –dry-run
  • –quiet
  • –force
• Caching
  • Cache States
  • Cache Expiry (TTL)
  • Cache Clearing on Migrate
  • Delta Computation
  • GridFS Fallback
  • Transaction-Aware Broadcasting
• API Reference
  • ContextChannel (Backend)
  • Decorators
  • Serializer Meta Options
  • Exceptions
  • WebSocket Protocol
  • Frontend API (TypeScript)
  • Cache System
  • Management Commands
  • Configuration