/botman-laravel-starter

Laravel + BotMan boilerplate repository

Primary LanguagePHP

BotMan Laravel Starter

This repository is an example Laravel application to instantly start developing cross-platform messaging bots using BotMan.

Installation

  1. Create a new bot project using this boilerplate.
composer create-project mpociot/botman-laravel-starter my_new_bot

  1. Install Laravel Valet and use valet share to retrieve a HTTPS URL that you can use in the messaging services for testing. The predefined route is /botman.

  2. Edit your .env file and connect BotMan with your Messaging Services

  3. Modify your bot logic in app/Http/Controllers/BotManController.php and/or routes/botman.php.

  4. Build awesome bots!

If you want to use the Slack RTM API, simply call php artisan botman:listen to let your bot connect to your Slack channel!

Extras

Add Facebook Get Started button

Adding a "Get Started" button resolves the issue of users not knowing what to write to break the ice with your bot. It is displayed the first time the user interacts with a Facebook chatbot. When you click it, it will send a payload (text) to BotMan and you can react to it and send the first welcome message to the user and tell him how to use your bot. In order to define this payload you need to send a CURL request with some data to Facebook. But BotMan can do that for you too!

First define the payload text in your services.php BotMan config.

'facebook_start_button_payload' => 'YOUR_PAYLOAD_TEXT'

Then run the artisan command php artisan botman:addFbStartButton which will add the Get Started button to your page's chat. You are now able to listen to this button with just the payload in your hears method.

$botman->hears('YOUR_PAYLOAD_TEXT', function (BotMan $bot) {
	...
});

License

BotMan and this boilerplate is free software distributed under the terms of the MIT license.