🎃 The easiest tool for creating ChatBots and Virtual Assistants. Join us.
1 - Download using Git in your terminal type:
git clone https://github.com/FrankBotHQ/FrankBot.git
2 - Downloading dependencies, type in your terminal:
npm install
3 - Runing sample bot, type in your terminal:
npm start
4 - Scan the QR Code that will appear in terminal and enjoy
6 - In the samples folder you will find several examples of implemented bots
| 🤖 Integrated with leading chatbot platforms such as RASA, BotPress, DialogFlow and more | 🚧 |
| 🐙 Integrated with major channels like slack, telegram, venom-bot, whatsapp-web.js and more | 🚧 |
| 📁 Send text, image, video, audio and docs | ✔️ |
| 👥 Get contacts, chats, groups, group members, Block List | 🚧 |
| 📞 Send contacts | 🚧 |
| Send Buttons | ✔️ |
| Send Lists | 🚧 |
| Send stickers/stickers GIF | 🚧 |
| Multiple Sessions | ✔️ |
| ⏩ Forward Messages | 🚧 |
| 📥 Receive message | ✔️ |
| 👤 insert user section | 🚧 |
| 📍 Send location!! | ✔️ |
| 🎃🎃 and much more | ✔️ |
Channel settings that can be passed in the channel create() method
| Attribute | Type | Default | Description |
|---|---|---|---|
bot (required) |
Bot | null |
Inform which object that implements the Bot interface will be used by the channel. |
logger |
Logger | ConsoleLogger |
Inform which object that implements the Logger interface will be used by the channel. |
- samples: Here you can find some implemented examples of bots created for some channels
- channels: Here are all the channels your bot can communicate, like: WhatsApp Web js, Slack, Telegram, discord, facebook, Terminal Console and more
- bots: here are all bot connectors, like: DialogFlow, BotPress, RASA, Api, Json, Database, CSV and more
- core: Here are all the files necessary for the framework to work
- logger: Here are the logging strategies you want to use in your application, like: console, database, api hook etc.
- ./index.ts: Sample bot using VenomBot Channel and Json to build answers
Check out our contributions guide: Contributing
By contributing your code, you agree to license your contribution under the MIT License. By contributing to the documentation, you agree to license your contribution under the Creative Commons Attribution 3.0 Unported License.