Giter Club home page Giter Club logo

botpress's Introduction

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.


๐Ÿ“ This version (Botpress X) is still in beta. See this branch for the latest stable archive.


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/or 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, major time should be spent on UX, not on the surrounding (and generic) features.

BotpressBotpressBotpress

Installation

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

npm install -g botpress@beta

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

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 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. PRs not respecting this commit style will be rejected.

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

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.

Publishing changes (Botpress team only)

Run ./push-changes.sh

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

botpress's People

Contributors

blazeu avatar daehli avatar denisgorbachev avatar devenbhooshan avatar dhavalsoni2001 avatar djanowski avatar emirotin avatar epaminond avatar ethangarrison avatar hugojosefson avatar ivanmayes avatar joepena avatar jonbaer avatar jsalwen avatar justinwatson avatar kirkwalk avatar larkinscott avatar lesyk avatar matheusmatos avatar maxim-mazurok avatar northerncodemky avatar ofelt avatar rayshih avatar rocel avatar russellschmidt avatar shayanb avatar slvnperron avatar snikic avatar wac2007 avatar wndisra avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.