catalysteria/laravel-ussd

USSD application builder for Laravel 8-12 with session continuity

1.1.0 2025-11-21 16:48 UTC

Requires

• php: ^8.1
• illuminate/cache: ^8.0|^9.0|^10.0|^11.0|^12.0
• illuminate/console: ^8.0|^9.0|^10.0|^11.0|^12.0
• illuminate/contracts: ^8.0|^9.0|^10.0|^11.0|^12.0
• illuminate/events: ^8.0|^9.0|^10.0|^11.0|^12.0
• illuminate/filesystem: ^8.0|^9.0|^10.0|^11.0|^12.0
• illuminate/http: ^8.0|^9.0|^10.0|^11.0|^12.0
• illuminate/routing: ^8.0|^9.0|^10.0|^11.0|^12.0
• illuminate/support: ^8.0|^9.0|^10.0|^11.0|^12.0

Requires (Dev)

• orchestra/testbench: ~6|~7|~8|~9|~10|~11
• phpunit/phpunit: ^9.6

MIT

• Your Name

• session
• laravel
• ussd
• continuity

README

Laravel 11 package for building state-driven USSD applications with session continuity.

Features

• State-oriented flow with fluent menu builder
• Actions for side-effect handling and branching
• Cache-backed session management with continuity resume option
• Machine orchestrator with configurable error and retry handling
• Gateway adapters for common USSD providers
• Artisan tooling for scaffolding states and actions
• Comprehensive testing utilities and documentation

Getting Started

1. Install via Composer:

   composer require catalysteria/laravel-ussd

2. Publish configuration:

   php artisan vendor:publish --provider="Vendor\\LaravelUssd\\Providers\\LaravelUssdServiceProvider"

3. Scaffold your first state:

   php artisan ussd:state WelcomeState

See docs/ for detailed usage, or visit the online documentation (once deployed).

Development

Auto-Update Packagist

To automatically update Packagist when you push changes, see Packagist Webhook Setup Guide.

Quick setup options:

• GitHub Webhook (Recommended): Configure webhook in GitHub repository settings
• GitHub Actions: Uses the workflow in .github/workflows/packagist-update.yml
• Manual Script: Run scripts/update-packagist.sh or scripts/update-packagist.bat