From cc4ae3391b6d1cf4930ec462b300fc8b9b87669d Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:44:27 +0000 Subject: [PATCH] docs: make Chinese README the default --- README.md | 151 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..25ef286 --- /dev/null +++ b/README.md @@ -0,0 +1,151 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/botpress/botpress) · [上游 README](https://github.com/botpress/botpress/blob/HEAD/readme.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + +
+ +# 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) 是构建由 OpenAI 驱动的**下一代聊天机器人**与智能助理的终极平台。以闪电般的速度为你的项目或企业打造出色的助理。 + +[快速入门](#getting-started) • +[Cloud](https://app.botpress.cloud) • +[文档](https://botpress.com/docs) • +[集成](#integrations) • +[插件](#plugins) + + + +
+ +## 本仓库 + +本仓库包含： + +- [**Integrations（集成）**](#integrations) – Botpress 在 [Botpress Hub](https://app.botpress.cloud/hub) 上维护的所有公开集成 +- [**Devtools（开发工具）**](#devtools) – 所有 Botpress Cloud 开发工具（CLI、SDK、API Client） +- [**Bots（机器人）**](#bots) - 仅使用 SDK 和 CLI 构建的「_as code_」机器人示例 +- [**Plugins（插件）**](#plugins) – [Botpress Studio](https://studio.botpress.cloud) 上的所有插件 **（即将推出）** + +## 贡献 + +我们欢迎来自社区的贡献！ + +我们欢迎针对本仓库中任何代码提交 Pull Request 和 Issue。更多详情请参阅[本仓库](#this-repository)一节。 + +对于与 Botpress Cloud 相关的缺陷或功能需求，你可以在本仓库创建 Issue，但请记住，在 [Discord](https://discord.gg/botpress) 上与我们交流能获得更快的响应！ + +对于与本地部署版 Botpress v12 相关的任何问题，请参阅 [Botpress v12 仓库](https://github.com/botpress/v12). + +## 集成 + +[`/integrations`](./integrations) 文件夹包含我们所有公开且开源的集成。我们邀请社区为我们的集成做贡献，或将你自己的集成发布到 [Botpress Hub](https://app.botpress.cloud/hub). + +### 集成开发 + +要开发集成，请先安装 [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 +``` + +然后，在你选择的目录中创建一个新的集成： + +```sh +bp init +``` + +此命令将从提供的模板之一生成一个集成。 + +_此步骤可在任意目录和 Git 仓库中执行。你无需 fork 本仓库即可创建集成。_ + +随后，你可以分别修改位于 `integration.definition.ts` 和 `src/index.ts` 文件中的集成定义与实现。 + +有关如何开发集成的更多信息，请参阅[文档](https://botpress.com/docs/for-developers/sdk/integration/getting-started). + +### 集成部署 + +要试用你的集成，可以使用 Botpress CLI 将其当前版本部署到你的工作区： + +```sh +bp deploy +``` + +这会将集成的当前版本部署到工作区，并供你所有机器人使用。若该版本已部署，则会更新；否则会创建新版本。 + +默认情况下，所有集成仅对其部署所在的工作区私有。当你准备与社区分享你的版本时，可以运行以下命令将其公开： + +```sh +bp deploy --visibility public +``` + +这会使你的集成在 [Botpress Hub](https://app.botpress.cloud/hub). 上对所有 Botpress 用户可用。集成版本一旦公开，便无法再次更新。 + +## 机器人 + +[`/bots`](./bots) 文件夹包含仅使用 client、SDK 和 CLI 构建的「_as code_」机器人示例。 + +**这不是构建机器人的推荐方式**，也绝非 Botpress Studio 的替代品。 + +不过，对于希望以更具编程化的方式构建机器人的资深开发者来说，它仍然很有用。 + +Botpress 团队内部也会使用这种方式，因为 Studio 与 SDK 都基于相同的底层原语。 + +## 插件 + +即将推出。 + +## 开发工具 + +| **Package（包）** | **Description（说明）** | **Docs（文档）** | **Code（代码）** | +| -------------------------------------------------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------- | +| [`@botpress/cli`](https://www.npmjs.com/package/@botpress/cli) | 构建、部署并管理机器人、集成与插件 | [Docs](https://www.botpress.com/docs/for-developers/sdk/cli-reference) | [Code](./packages/cli) | +| [`@botpress/client`](https://www.npmjs.com/package/@botpress/client) | 用于调用 Botpress API 的类型安全客户端 | [Docs]() | [Code]() | +| [`@botpress/sdk`](https://www.npmjs.com/package/@botpress/sdk) | 用于构建集成的 SDK | [Docs]() | [Code]() | + +## 本地开发 + +### 前置条件 + +开发环境需要安装以下工具： + +- [`git`](https://git-scm.com/): Git 是一款免费开源的分布式版本控制系统。 +- [`node`](https://nodejs.org/en/): Node.js® 是基于 Chrome V8 JavaScript 引擎构建的 JavaScript 运行时。 +- [`pnpm`](https://pnpm.io/): PNPM 是一款快速且节省磁盘空间的包管理器。 + +#### Windows 专用前置条件 + +- [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) + +### 从源码构建 + +```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 +``` + +## 许可 + +本仓库中的所有包均为开源软件，并根据 [MIT License](LICENSE) 许可。在本仓库贡献代码即表示你同意以相同许可发布你的代码。 + +让我们一起构建聊天机器人开发的未来！🤖🚀