Inferable 项目使用教程

1. 项目目录结构及介绍

Inferable 是一个支持创建带有人机交互的 AI 工作流的平台。以下是项目的目录结构及其简单介绍：

inferable/
├── .github/                # GitHub 工作流和模板
├── .husky/                 # Husky 配置文件，用于 Git 钩子
├── .vscode/                # Visual Studio Code 的项目配置
├── adapters/               # 适配器目录，包含不同数据库的适配器
├── app/                    # 应用目录，包含 playground 和管理控制台的前端代码
├── archives/               # 存档目录
├── assets/                 # 资源目录，包含示例和文档的静态文件
├── bootstrap-dotnet/       # .NET 的引导项目
├── bootstrap-go/           # Go 语言的引导项目
├── bootstrap-node/         # Node.js 的引导项目
├── cli/                    # 命令行接口工具（alpha 版本）
├── control-plane/          # 控制平面服务，Inferable 的核心服务
├── demos/                  # 示例目录
├── load-tests/             # 负载测试目录
├── sdk-bash/               # Bash SDK 目录
├── sdk-dotnet/             # .NET SDK 目录（实验性）
├── sdk-go/                 # Go SDK 目录
├── sdk-node/               # Node.js SDK 目录
├── sdk-react/              # React SDK 目录
├── .editorconfig            # 编辑器配置文件
├── .gitignore              # Git 忽略文件
├── .prettierrc             # Prettier 配置文件
├── CHANGELOG.md            # 更新日志
├── CONTRIBUTING.md         # 贡献指南
├── LICENSE                 # 许可证文件
├── README.md               # 项目说明文件
└── package.json            # npm 包配置文件

2. 项目的启动文件介绍

Inferable 项目的启动文件根据不同的模块有所不同。以下是一些主要的启动文件：

• app/: 应用模块的启动文件通常在 app/ 目录中，可能包括启动 Web 服务器和前端服务的脚本。
• cli/: 命令行工具的启动文件在 cli/ 目录中，通常是 index.js 或 main.go 这样的文件。
• control-plane/: 控制平面服务的启动文件在 control-plane/ 目录中，它是整个系统的核心。

具体到文件，以下是一些可能的启动文件：

• app/server.js: 可能是 Node.js 的服务器启动文件。
• cli/index.js: Node.js 命令行工具的入口文件。
• control-plane/main.go: Go 语言的控制平面服务启动文件。

3. 项目的配置文件介绍

Inferable 项目的配置文件分布在项目的各个部分，以下是一些主要的配置文件：

• .editorconfig: 用于定义项目编辑器的代码风格配置。
• .prettierrc: Prettier 代码格式化工具的配置文件。
• package.json: npm 包的配置文件，其中可能包括项目的依赖和脚本。

其他配置文件可能包括：

• app/config.json: 应用模块的配置文件，用于配置 Web 服务器和前端设置。
• control-plane/config.yaml: 控制平面服务的配置文件，用于定义服务的配置参数。
• sdk-*/config.json: 各种 SDK 的配置文件，用于定义 SDK 的行为和设置。