Getting Started with Sword

CLI Status

The sword-cli command line tool is currently in development. For now, the recommended way to start with Sword is to review and run the examples in the repository.

Examples

You can find the examples in the repository on GitHub.

Each example is designed to showcase a specific part of the framework. If this is your first time using Sword, we recommend starting with web.

web Example

This is the most straightforward example for understanding the base flow of an Axum-based HTTP application with Sword.

It includes:

• Module registration
• Web controllers
• Components and providers
• Configuration from a file

socketio Example

This example focuses on Socket.IO integration with Sword, built on top of the socketioxide crate.

It includes:

• Module registration
• Socket.IO controllers
• Event handling
• [socketio] configuration

interceptors Example

This example focuses on interceptors applied to web and Socket.IO controllers.

It includes:

• Web interceptors
• Socket.IO connection interceptors
• Combined use with layers and configuration