|
| 1 | +<div align="center"> |
| 2 | + |
1 | 3 | # Botpress Cloud
|
2 | 4 |
|
3 |
| -Better description incoming. |
| 5 | +[](https://discord.gg/botpress) |
| 6 | +[](https://www.youtube.com/c/botpress) |
| 7 | +[](https://docs.botpress.cloud) |
| 8 | +[](https://www.npmjs.com/package/@botpress/sdk) |
| 9 | +[](https://www.npmjs.com/package/@botpress/cli) |
| 10 | + |
| 11 | +[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. |
| 12 | + |
| 13 | +[Getting started](#getting-started) • |
| 14 | +[Cloud](https://app.botpress.cloud) • |
| 15 | +[Documentation](https://botpress.com/docs) • |
| 16 | +[Integrations](#integrations) • |
| 17 | +[Agents](#agents) |
| 18 | + |
| 19 | +<img src="https://user-images.githubusercontent.com/10071388/248040379-8aee1b03-c483-4040-8ee0-741554310e88.png" width="800"> |
| 20 | + |
| 21 | +</div> |
| 22 | + |
| 23 | +## Getting started |
| 24 | + |
| 25 | +This repository contains: |
| 26 | + |
| 27 | +- [**Integrations**](#integrations) – all public integrations on the [Botpress Hub](https://app.botpress.cloud/hub) |
| 28 | +- [**Agents**](#agents) – all public agents on the [Botpress Studio](https://studio.botpress.cloud) **(coming soon)** |
| 29 | +- [**Devtools**](#devtools) – all Botpress Cloud dev tools (CLI, SDK, API Client) |
| 30 | + |
| 31 | +## Integrations |
| 32 | + |
| 33 | +The [`/integrations`](./integrations) folder contains all our public and open-source integrations. We invite the community to contribute their own integrations to Botpress Cloud. |
| 34 | + |
| 35 | +Create integrations using the **Botpress CLI** and submit a pull request to make your mark on the future of chatbots. |
| 36 | + |
| 37 | +### Installation |
| 38 | + |
| 39 | +The Botpress Cloud environment is built using **Typescript** and [**Node.js**](https://nodejs.org). |
| 40 | +Make sure you have a recent version of Node (>16) and npm installed. |
| 41 | + |
| 42 | +```sh |
| 43 | +npm install -g @botpress/cli # for npm |
| 44 | +yarn global add @botpress/cli # for yarn |
| 45 | +pnpm i -g @botpress/cli # for pnpm |
| 46 | +``` |
4 | 47 |
|
5 |
| -### Prerequisites |
| 48 | +### Usage |
6 | 49 |
|
7 |
| -The development environment requires the following tools to be installed: |
| 50 | +```sh |
| 51 | +# Login for the first time |
| 52 | +bp login |
8 | 53 |
|
9 |
| -- [`node`](https://nodejs.org/en/): Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. |
10 |
| -- [`pnpm`](https://pnpm.io/): Fast, disk space efficient package manager. |
11 |
| -- [`Tilt`](https://tilt.dev/): A toolkit for fixing the pains of microservice development. |
12 |
| -- [`docker`](https://www.docker.com/): Docker is an OCI container toolkit |
| 54 | +# Interactive command to build a new integration |
| 55 | +bp init |
| 56 | +``` |
| 57 | + |
| 58 | +### Deploying a Private Integration |
| 59 | + |
| 60 | +By default, all integrations are private to the workspace they have been deployed in. |
| 61 | + |
| 62 | +```sh |
| 63 | +bp deploy |
| 64 | +``` |
| 65 | + |
| 66 | +### Making your Integration Public |
| 67 | + |
| 68 | +To submit your integration to the Botpress Hub and make it publicly available to the community, please make a pull request to this repository by following these [Integration Contribution guidelines](./integrations). |
| 69 | + |
| 70 | +## Agents |
| 71 | + |
| 72 | +Coming soon. |
| 73 | + |
| 74 | +## Devtools |
| 75 | + |
| 76 | +| **Package** | **Description** | **Docs** | **Code** | |
| 77 | +| -------------------------------------------------------------------- | ----------------------------------------------- | -------------------------------------------------- | ---------------------- | |
| 78 | +| [`@botpress/cli`](https://www.npmjs.com/package/@botpress/cli) | Build and deploy private or public integrations | [Docs](https://botpress.com/docs/integration/cli/) | [Code](./packages/cli) | |
| 79 | +| [`@botpress/client`](https://www.npmjs.com/package/@botpress/client) | Type-safe client to consume the Botpress APIs | [Docs]() | [Code]() | |
| 80 | +| [`@botpress/sdk`](https://www.npmjs.com/package/@botpress/sdk) | Internal package used by to build integrations | [Docs]() | [Code]() | |
| 81 | + |
| 82 | +## Contributing |
| 83 | + |
| 84 | +We love contributions from the community! We welcome pull requests that provide improvements or bug fixes for the CLI, Client, SDK or Integrations. |
| 85 | + |
| 86 | +Please keep the contributions to integrations and open-source packages. For bugs or features related to the API, Botpress Cloud or the Botpress Studio, please talk to us on [Discord](https://discord.gg/botpress) instead! |
13 | 87 |
|
14 | 88 | ## Licensing
|
15 | 89 |
|
16 |
| -This software is protected by the same license as the [main Botpress repository](https://github.com/botpress/botpress). You can find the license file [here](https://github.com/botpress/botpress/blob/master/LICENSE). |
| 90 | +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. |
| 91 | + |
| 92 | +Let's build the future of chatbot development together! 🤖🚀 |
0 commit comments