A BotMan starter project to introduce BotMan.
Once everything is setup (follow #setup below), you can access your botman studio installation at localhost
All Botman routes are in /routes/botman.php, edit new routes there.
All conversations are in app/Conversations
Example BotMan controller is situated at app/Http/Controllers/BotManController
New BotMan controllers are situated at app/Http/Controllers/Listen
You can test your bot using the web driver at tinker
Note: Powerpoint is included in root file under BotMan Intro - Liam Norman.key for keypoint file and
BotMan Intro - Liam Norman ppt.pptx for powerpoint file.
To install using docker, please ensure you have the relevant version of Docker CE for your OS installed.
To start using this project, there are a few setup steps that you need to take which include things like composer installation and setting up env files.
Here's the commands you need to run to get going:
# From the root of the project
# Copy the example env files
cp .env.example .env
cp .docker.env.example .docker.env
# Install composer dependencies
composer install
# Generate a key
php artisan key:generate
npm install && npm run dev
# Build the Docker images and run containers
docker-compose up --build
# Migrate the database in the container
docker-compose run --rm app /bin/bash
# Now inside the container
php artisan migrate
When you have the Docker environment running you can connect to a database via a GUI application or MySQL command line. Here's how you would connect from the console, for local development:
mysql -u root -proot -P13306 -h 127.0.0.1
The docker-compose.yml file contains the environment configuration for the MySQL database name, users, and root password for reference.
The mysql service in the Docker Compose file maps port 13306 on the host machine to 3306 on the container so that it doesn't interrupt any local MySQL instances you might have running. I've just added a 1 in front of the 3306 as 13306 if you want an easy way to remember the port exposed for MySQL.
Christoph Rumpel - build chatbots with PHP
While BotMan itself is framework agnostic, BotMan is also available as a bundle with the great Laravel PHP framework. This bundled version is called BotMan Studio and makes your chatbot development experience even better. By providing testing tools, an out of the box web driver implementation and additional tools like an enhanced CLI with driver installation, class generation and configuration support, it speeds up the development significantly.
You can find the BotMan and BotMan Studio documentation at http://botman.io.
Do you like this project? Support it by donating
If you discover a security vulnerability within BotMan or BotMan Studio, please send an e-mail to Marcel Pociot at m.pociot@gmail.com. All security vulnerabilities will be promptly addressed.
BotMan is free software distributed under the terms of the MIT license.