Botpress — The open-source bot platform

Botpress is an open-source all-in-one bot creation platform that provides all the tools you need to build, debug and deploy AI-based conversational assistants.

• Developer-focused
• Natural Language Understanding (NLU)
• Built-in graphical interface & flow editor
• Administration panel and bot management tools
• Runs fully on-prem (control your data)
• Support multiple messaging channels such as Webchat, SMS, Telegram, Facebook Messenger etc

---

Learn Botpress

📖 v12 Documentation	🍿 YouTube Channel

Follow us

💬 Community	🚀 Blog	🐥 Twitter

Community / Support / Forum

Support the project ⭐

If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us get visability and allow the community to grow. 🙏

Pre-built Binaries

You can download the binaries here.

Building from source

Prerequisites: Node 10.11 (you can use nvm) and Yarn.

1. Run yarn to fetch node packages.
2. Run yarn build to build the core, the UI and the modules.
3. Run yarn start to start the server.

Building issues

If you encounter errors when building modules (timeout, random errors, etc), try the following:

1. Go in each module folder and type yarn && yarn build

Documentation

Developer's Guide

We use Docusaurus to create the Developer's Guide.

• To start the development server, run yarn start:guide
• To generate the static files, run yarn build:guide. The generated files will appear under /docs/guide/build
• To deploy a new version of the documentation, run yarn run version <version here>

SDK Reference

We use TypeDoc to generate the SDK Reference directly from the source code.

• Run yarn build:reference to generate the documentation. The static files will appear under /docs/reference/public.

Contributing

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

• Check out our contributing guide
• Check misspelling in our docs.
• Look at our code of conduct
• Engage with us on Social Media
  • Follow us on Twitter
• Answer and ask questions on the Forum

For starters, there are some open issues with the [first good issue][starter-label] tag which are ideal for starting to contribute. They are all relatively easy to get started with.

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.

Please follow the Conventional Commits specs when doing commits. Pull requests not respecting this commit style will be rejected.

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.