Skip to content

davidbwire/instant-ussd-app

Repository files navigation

InstantUssd App

This project recommends a file structure for incorporating bitmarshals/instant-ussd USSD library to your project.

It also provides the quickest way to boot up a fully functional USSD application within 3 minutes or less.

Goals

  • Speed up USSD development
  • Ease maintenance of USSD code

Features

  • Minimal coding (provide USSD menus as config)
  • Automatic screen to screen navigation
  • Out of the box validation of user inputs
  • Ready solutions for complex USSD flows involving going back and forth, optional screens, looping set of screens, jumping from screen to screen and resuming timed-out USSD sessions

Requirements

PHP >=5.6

bitmarshals/instant-ussd:0.1.*

Installation

Via Composer

Run

$ composer create-project davidbwire/instant-ussd-app

Configure database tables and connection (see below)

Configuration

Import instant ussd tables from database.sql file and then add database connection params to the config file.

Finally, map incoming USSD requests to http://your_domain_or_ip/callback.php

Documentation

  1. How It Works
  2. Configuration
  3. Capturing Incoming Data

License

InstantUssd App is open-sourced software licensed under the MIT license.