diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..6ff9edc --- /dev/null +++ b/README.en.md @@ -0,0 +1,145 @@ +
+ +# Botpress Cloud + +[![Discord](https://img.shields.io/badge/Join_Community-white?color=7289da&label=Discord&labelColor=6a7ec1&logo=discord&logoColor=FFF)](https://discord.gg/botpress) +[![YouTube Subscribe](https://img.shields.io/badge/YouTube-red?logo=youtube&logoColor=white)](https://www.youtube.com/c/botpress) +[![Documentation](https://img.shields.io/badge/Documentation-blue?logo=typescript&logoColor=white)](https://docs.botpress.cloud) +[![@botpress/sdk](https://img.shields.io/badge/@botpress%2fsdk-black?logo=npm)](https://www.npmjs.com/package/@botpress/sdk) +[![@botpress/cli](https://img.shields.io/badge/@botpress%2fcli-black?logo=npm)](https://www.npmjs.com/package/@botpress/cli) + +[Botpress](https://botpress.com) is the ultimate platform for building **next-generation chatbots** and assistants powered by OpenAI. Start building incredible assistants for your projects or businesses at lightning speed. + +[Getting started](#getting-started) • +[Cloud](https://app.botpress.cloud) • +[Documentation](https://botpress.com/docs) • +[Integrations](#integrations) • +[Plugins](#plugins) + + + +
+ +## This Repository + +This repository contains: + +- [**Integrations**](#integrations) – all public integrations on the [Botpress Hub](https://app.botpress.cloud/hub) maintained by Botpress +- [**Devtools**](#devtools) – all Botpress Cloud dev tools (CLI, SDK, API Client) +- [**Bots**](#bots) - some example of bots "_as code_" made only using the SDK and the CLI +- [**Plugins**](#plugins) – all plugins on the [Botpress Studio](https://studio.botpress.cloud) **(coming soon)** + +## Contributing + +We love contributions from the community! + +We welcome pull requests and issues relevant for any code contained in this repository. See the [This Repository](#this-repository) section for more details. + +For bugs or features related to Botpress Cloud, you may create an issue on this repository, but keep in mind that you will get a faster response by talking to us on [Discord](https://discord.gg/botpress) instead! + +For any problem related to on-premise Botpress v12, please see the [Botpress v12 repository](https://github.com/botpress/v12). + +## Integrations + +The [`/integrations`](./integrations) folder contains all our public and open-source integrations. We invite the community to contribute to our integrations or to publish their own to the [Botpress Hub](https://app.botpress.cloud/hub). + +### Integration Development + +To develop an integration, start by installing the [Botpress CLI](https://www.npmjs.com/package/@botpress/cli): + +```sh +npm install -g @botpress/cli # for npm +yarn global add @botpress/cli # for yarn +pnpm install -g @botpress/cli # for pnpm +``` + +Then, in the directory of your choice, create a new integration: + +```sh +bp init +``` + +This command will generate an integration from one of the proposed templates. + +_This step can be executed in any directory and git repository of your choice. You don't have to fork this repository to create an integration._ + +You can then modify both the definition and implementation of your integration respectively located in the `integration.definition.ts` and `src/index.ts` files. + +For more information on how to develop an integration, please refer to the [Documentation](https://botpress.com/docs/for-developers/sdk/integration/getting-started). + +### Integration Deployment + +To try out your integration, you can deploy its current version to your workspace using the Botpress CLI: + +```sh +bp deploy +``` + +This will deploy your integration's current version to your workspace and make it available to all your bots. If this version is already deployed, it will be updated. Otherwise, a new version will be created. + +By default, all integrations are private to the workspace they have been deployed in. When you are ready to share your version with the community, you can make it public by running: + +```sh +bp deploy --visibility public +``` + +This will make your integration available to all Botpress users on the [Botpress Hub](https://app.botpress.cloud/hub). Once a version of your integration is public, it cannot be updated again. + +## Bots + +The [`/bots`](./bots) folder contains examples of bots "_as code_" made only using the client, the SDK and the CLI. + +**This is not the recommended way to build bots** and is in no way a replacement for the Botpress Studio. + +However it can be useful for experienced developers who want to build bots in a more programmatic way. + +It is also used internally by the Botpress team since the Studio and SDK both use the same underlying primitives. + +## Plugins + +Coming soon. + +## Devtools + +| **Package** | **Description** | **Docs** | **Code** | +| -------------------------------------------------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------- | +| [`@botpress/cli`](https://www.npmjs.com/package/@botpress/cli) | Build, Deploy and Manage Bots, Integrations and Plugins | [Docs](https://www.botpress.com/docs/for-developers/sdk/cli-reference) | [Code](./packages/cli) | +| [`@botpress/client`](https://www.npmjs.com/package/@botpress/client) | Type-safe clients to consume the Botpress APIs | [Docs]() | [Code]() | +| [`@botpress/sdk`](https://www.npmjs.com/package/@botpress/sdk) | SDK used by to build integrations | [Docs]() | [Code]() | + +## Local Development + +### Prerequisites + +The development environment requires the following tools to be installed: + +- [`git`](https://git-scm.com/): Git is a free and open source distributed version control system. +- [`node`](https://nodejs.org/en/): Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. +- [`pnpm`](https://pnpm.io/): PNPM is a fast, disk space efficient package manager. + +#### Windows-specific prerequisites + +- [Microsoft Visual C++ Redistributable for Visual Studio 2015-2022](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist#visual-studio-2015-2017-2019-and-2022) + +### Building from sources + +```sh +# Clone the repository +git clone https://github.com/botpress/botpress.git +cd botpress + +# Install dependencies +pnpm install + +# Build all packages +pnpm run build + +# Run Checks +pnpm run check +``` + +## Licensing + +All packages in this repository are open-source software and licensed under the [MIT License](LICENSE). By contributing in this repository, you agree to release your code under this license as well. + +Let's build the future of chatbot development together! 🤖🚀