/bbot-boilerplate

A starter bot using the bBot engine, to make your own.

Primary LanguageJavaScriptMIT LicenseMIT

bbot-boilerplate

A starter bot using the bBot engine, to make your own.

1. 🍴 Fork or clone this repo

  • git clone amazebot/bbot-boilerplate MY_BOT
  • to clone without git history, add --depth 1 flag
  • or once cloned, start a fresh history rm -rf .git && git init

2. 💻 Setup your project

  • npm install get dependencies
  • npm run setup add your details

3. ✨ Test in shell

  • npm start

4. 👨‍💻 Start coding

  • customise index.js
  • look at examples.js

5. 💬 Run in a chat platform

  • choose a message adapter (install package or use one we include).
  • setting login credentials in .env file, environment or package settings.
  • e.g. start chatting live with npm start -- -m rocketchat

Easy deployment options coming soon.

Go to the bbot repo for system requirements.

See bbot.chat for get started guides.