@bot-js/core

BotJS Framework

A progressive Node.js framework for building efficient, scalable,
and enterprise-grade bot applications 🚀
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Botjs is a progressive Node.js framework for building efficient, scalable, and enterprise-grade bot applications built as a wrapper framework around botkit. So, why a new framework?

Here's why:

• The open source offerings for bot development in the same technology stack were pretty low.
• Taking the benefit of Typescript decorators, it gives bot developers good readability and command over their programming using OO Techniques.
• Supports the existing botkit adapters available as starter templates using the create-botjs npm package.
• Supports automatic dependency injections in code through smart controllers.
• And many more!

This project is heavily inspired from nestjs framework and adapts the best practices from the same to allow bot developers build amazing and robust bot applications.

Of course, we do not intend to undermine the fascinating botkit library. In fact, we built this framework around botkit so any existing botkit plugins out there are supported right out of the box!

Built With

• Botkit - an open source developer tool for building chat bots, apps and custom integrations for major messaging platforms.
• ESLint - a static code analysis tool for identifying problematic patterns found in JavaScript code.
• Typescript - an open-source language which builds on JavaScript, one of the world’s most used tools, by adding static type definitions.
• And many other npm goodies!

Getting Started

Before we begin, please make sure that you have the prerequisites installed and ready for use. We recommend using the iterm2 terminal if you are using Mac as the logs look beautiful in the iterm2 terminal! The project would still work with a normal terminal.

Prerequisites

• Node 12.x and above - We recommend using the LTS version. To check out the latest LTS version, click here.

Installation

Please visit our website https://botjs.org for detailed documentation and tutorials.

Getting started with a botjs project is pretty easy and straight froward. Run the following commands in the directory where you want to create your project.

Using npx

npx create-botjs <name>

Using yarn

yarn create botjs <name>

and follow the prompts.

Usage

For usage and additional documentation please visit https://botjs.org.

Roadmap

• Documentation and support for additional botkit adapters.
• Use case examples on the website.
• CI / CD pipelines for enabling open source contribution.

Contributing

• We would soon open up for contributions after our next release.
• We are currently working on some internal process flows to accelerate the contributions!
• We would start reviewing the pull requests as soon as we open up for contribution!
• Till then, feel free to fork the repository and play with the code.

License

• Open Source MIT

Contact

• Shivam Dhruva - You can find the contact details on his website.

Acknowledgements

• Thank you botkit ! For bringing such simplicity to bot application development.