User Guide

This user guide provides detailed information about each component of Chanx and how to use them effectively in your applications.

Core Components

Chanx consists of several core components that work together to provide a comprehensive WebSocket framework:

  1. WebSocket Consumers: Base consumer classes with authentication, messages, and group handling

  2. Message System: Pydantic-based message validation and routing

  3. Authentication: DRF-style authentication for WebSocket connections

  4. Testing: Specialized tools for testing WebSocket endpoints

  5. Playground: Interactive UI for exploring and testing WebSocket endpoints

Getting Started

If you're new to Chanx, we recommend working through the guides in this order:

  1. Start with Authentication to understand how WebSocket connections are secured

  2. Move on to Messages System to learn about structured message handling

  3. Explore Consumers to see how consumers pull everything together

  4. See Testing for guidance on testing your WebSocket endpoints

  5. Try the WebSocket Playground for interactive exploration of your endpoints

Or jump directly to the guide that addresses your current need.

Next Steps

Begin your journey by learning about Authentication in Chanx, or if you're ready to see complete examples, check out the Examples.