bbot

An adaptable engine for conversational UI

#master

#develop

---

Using bBot

👩‍💻
Visit bbot.chat for docs on installing and running and guides for building with bBot.

🤓
Dig into the generated API docs for full details of every module and method.

💻
Use our starter code, bundled with a setup script and basic examples. Grab the bBot Boilerplate.

Getting Support

🚀
Join the #bbot community support channel on the Rocket.Chat open server.

🙋‍
While in pre-release, priority support can only be provided to our sponsors and enterprise partners.

Giving Support

🌟
We need 100 stars to setup an Open Collective. Please star the project on GitHub and join our stargazers.

✉️
We are an open source project sponsored by enterprise partners. Contact us if you'd like become a sponsor.

Contributing

❤️
We live for open source and love contributions. Join our contributor community on Rocket.Chat.

🏛️
Before you get started, please read our Code of Conduct.

🤯
If you're unfamiliar with the process, please read the amazing How to Contribute to Open Source.

👨‍💻
Test and compile with yarn build before commits. Use yarn commit for the commitizen commit message wizard.

❓
Looking for somewhere to get started? Review our basic and help wanted issues.

Development

Use package scripts for dev workflow:

• yarn test to check changes for error
• yarn test:watch to auto-test changes
• yarn build to test and compile
• yarn build:watch to auto-compile changes
• yarn link to use as local dependency
• yarn stage to stage all changes
• yarn commit to run commit wizard
• yarn local to run bot from source
• yarn start to run bot from dist

Clone Project

System requirements (osx):

Requirement	Command
Homebrew	/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Node.js	brew install node
Yarn	npm install -g yarn

Install and run bBot:

Step	Command
Clone bBot	git clone https://github.com/Amazebot/bbot.git bbot
Enter path	cd bbot
Install deps	yarn install
Run shell chat	yarn local

Chat in Rocket.Chat

System requirements (osx):

Requirement	Command
Homebrew	/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Meteor	curl https://install.meteor.com/ | sh
MongoDB	brew install mongodb
Mongo service	ln -sfv /usr/local/opt/mongodb/*.plist ~/Library/LaunchAgents

Run Rocket.Chat instance (outside bBot path):

Step	Command
Clone Rocket.Chat	git clone https://github.com/RocketChat/Rocket.Chat.git rocketchat-bbot
Enter path	cd rocketchat-bbot
Install deps	meteor npm install
Run Rocket.Chat	export MONGO_URL='mongodb://localhost:27017/rc-bbot'; meteor
Create bot user	https://rocket.chat/docs/bots/creating-bot-users/

Run bBot with Rocket.Chat (from bBot path):

Step	Command
Create .env	touch .env
Edit .env	open .env
Configure	ROCKETCHAT_USER="mybot" ROCKETCHAT_PASSWORD="mybotpassword" LISTEN_ON_ALL_PUBLIC=true RESPOND_TO_DM=true RESPOND_TO_EDITED=true
Run from source	yarn local -m rocketchat