Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    botpresspublic

    Botpress — The only sane way of building great bots

    CircleCI

    Botpress is an open-source bot creation tool written in Javascript. It is powered by a rich set of open-source modules built by the community. We like to say that Botpress is like the Wordpress of Chatbots; anyone can create and reuse other people's modules.


    Learn Botpress
    📖 Documentation 🎓 Examples 🍿 YouTube Tutorials
    Follow us
    🖥 Website 💬 Slack 📦 Modules 🚀 Blog 🐥 Twitter

    ⚠️ Make sure you join our Slack Community for help, announcements, gigs and fun!

    What is Botpress

    Botpress is on a mission to make useful bots ubiquitous by powering developers with the best possible tools to build & manage chatbots. We believe that in order to create great bots, major time should be spent on UX, not on the surrounding (and generic) features.

    Botpress is a free & open-source bot-building platform that ships with:

    What it looks like

    BotpressBotpressBotpress

    Getting Started Quickly

    The best way to get quickly get started using Botpress is to watch our video tutorials.

    Botpress

    Installation

    Botpress requires node (version >= 4.6) and uses npm as package manager.

    npm install -g botpress
    

    Creating a bot

    Creating a bot is simple, you need to run botpress init in a terminal inside an empty directory:

    botpress init my-bot
    

    Once your bot is created, you need to run botpress start to start your bot:

    botpress start
    

    This will provide you locally a web interface available at http://localhost:3000

    Adding stuff to your bot

    At this point, your bot does nothing, you need to add features. There are two ways to add features:

    • Installing modules
    • Coding

    Installing modules

    For example, there's a botpress-messenger module that will make your bot connect to Facebook Messenger and easily send/receive messages.

    You can install modules directly in the web interface, or by using the botpress install command:

    botpress install messenger
    

    Once installed, modules expose two things:

    • A graphical interface (available in the left panel). This makes configuration easy and convenient. You don't need to know about coding to use the graphical interface.
    • Features via APIs. Each module has a detailed documentation on how to use their API.

    Coding to add features

    As the number of modules increase, we expect that the amount of code you'll need to write will lower everyday. Developers can add code directly in the bot (i.e. index.js) and access the core and modules features. For example, if you wish to respond to a GETTING_STARTED event on Facebook Messenger, you might code something along these lines:

    bp.hear({ type: 'postback', text: 'GETTING_STARTED' }, (event, next) => {
      bp.messenger.sendText(event.user.id, 'Hello, human!')
    })

    To create a basic Hello Human bot in one minute, please read the Getting Started.

    For learn all about Botpress, please read our full Documentation

    Documentation

    🎓 Examples

    Modules

    This is a non-exclusive list of modules Botpress has. See the full list of modules.

    Module Maintainer
    botpress-wit.ai @danyfs
    botpress-subscription @slvnperron
    botpress-terminal @slvnperron
    botpress-analytics @danyfs
    botpress-broadcast @slvnperron
    botpress-rivescript @danyfs
    botpress-messenger @slvnperron
    botpress-slack @danyfs
    botpress-discord @TheFreakLord
    botpress-dialog @phildionne
    botpress-scheduler @slvnperron
    botpress-hitl @danyfs
    botpress-api.ai @slvnperron
    botpress-web @slvnperron

    Contributing

    Thanks you for your interest in Botpress. Here are some of the many ways to contribute.

    For starters, there are some open issues with the for-new-contributors tag which are ideal for starting to contribute. They are all relatively easy to get started with.

    If you would like to contribute any new feature or bug fix, please make sure that there is a GitHub issue first. If there is not, simply open one and assign it to yourself. If you are unsure on how to get started, ask us anything in the Slack or email us at info [AT] botpress.io.

    Contributions to Botpress will be dual-licensed under AGPLv3 and the Botpress Proprietary License. This means that all contributors need to agree to the dual-license before their contributions can be accepted.

    Community

    There's a Slack community where you are welcome to join us, ask any question and even help others.

    Get an invite and join us now! 👉 https://slack.botpress.io

    License

    Botpress is dual-licensed under AGPLv3 and the Botpress Proprietary License.

    By default, any bot created with Botpress is licensed under AGPLv3, but you may change to the Botpress License from within your bot's web interface in a few clicks.

    For more information about how the dual-license works and why it works that way please see the FAQS.

    Credits

    Emoji provided free by EmojiOne

    install

    npm i botpress

    Downloadsweekly downloads

    728

    version

    1.1.13

    license

    AGPL-3.0

    repository

    githubgithub

    last publish

    collaborators

    • avatar
    • avatar
    • avatar
    • avatar