JavaScript CSS Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Botpress β€” The open-source bot platform

CircleCI npm

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
πŸ“– v10 Documentation
Follow us
πŸ–₯ Website πŸ’¬ Slack πŸš€ Blog πŸ₯ Twitter

πŸ‘‰ Make sure you join our Slack Community for help, announcements, gigs and fun!

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 getting known and grow the community. πŸ™

Botpress

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, significant time should be spent on user experience, not on the surrounding (and generic) features.

BotpressBotpressBotpress

Installation

Botpress requires Node.js (version >= 8.2) 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 with a web interface available at http://localhost:3000 and a chat window at http://localhost:3000/s/chat

Contributing

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

For starters, there are some open issues with the first good issue 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.

Development steps

To modify, test or create modules, please install lerna.

Then run lerna bootstrap. This will initialize all modules and link them (using yarn link). Then in your bot, use yarn link @botpress/module-name to use the local version of that module.

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