嵌入式分析SDK - CLI快速入门

我们创建了一个单一命令来启动Metabase并帮助您在应用程序中快速创建嵌入式仪表板。此设置不会在生产环境中工作；它仅供您快速在本地机器上测试SDK。

先决条件

• Docker
• Node.js 18.x LTS或更高版本。
• 许可证（可选 - 仅当您想尝试多租户时）。
• 数据库（您可以连接到应用程序的数据库）。

快速入门命令

切换到React应用程序并运行

npx @metabase/embedding-sdk-react@latest start

脚本概述

该脚本将引导您进行设置。需要组合很多组件，因此这里概述了命令执行的操作。

1. 检查您是否在React应用程序中安装SDK。
2. 查找或安装嵌入式分析SDK。
3. 在Docker上启动Metabase。这需要一些时间。要查看Docker容器的状态，请使用docker ps命令。或者，您可以使用这段时间来反思您最近做出的良好选择。
4. 要求您输入电子邮件地址以在Metabase中创建第一个管理员账户。
5. 生成一个新的API密钥。脚本将构建一个模拟的Express服务器，该服务器将使用此密钥对向您的Metabase的请求进行认证。
6. 提示您连接到数据库。选择您的数据库引擎。您需要数据库的主机、端口、用户名和密码（如果PostgreSQL，您还可以使用身份验证提供者）。
7. 连接到数据库，并提示您选择要嵌入的数据库中的表。选择1-3个表。如果您想查看多租户的实际应用，请选择包含用户ID的表。Metabase将分析这些表以创建要嵌入的仪表板。
8. (可选)：如果您拥有Pro/EE许可证，脚本可以设置权限。要获取许可证，请注册自托管Metabase Pro免费试用。
9. (可选)：如果您设置了多租户，脚本会要求您输入用于沙盒表的列（例如，用户ID列）。Metabase将根据该列的值沙盒数据。
10. 在您的React应用“./components/metabase”中生成示例React组件文件（您可能需要将它们移动到您的src目录）。
11. 询问您（脚本）应在何处保存模拟Express服务器（默认：./mock-server）。它将使用npm install安装模拟服务器的依赖项。
12. 提示您在另一个终端会话中启动模拟服务器。切换到模拟服务器的目录并运行

    npm run start
    

    一旦模拟服务器启动，返回脚本的终端会话并按下以继续。

13. 提示您在您的客户端应用中添加以下import。

    import { AnalyticsPage } from "././components/metabase";
    

    确保from路径有效（根据您的应用，您可能需要将组件移动到新目录）。

14. 提示您将<AnalyticsPage />组件添加到您的页面。
15. 启动您的应用，查看添加了<AnalyticsPage />组件的页面，您应该看到一个嵌入的仪表板。

您的Metabase应运行在https://127.0.0.1:3366。您可以在METABASE_LOGIN.json中找到您的登录凭据。

进一步阅读

• 使用示例应用和JWT的快速入门