添加“在 Firebase Studio 中打开”按钮

借助 Firebase Studio,您可以简化代码库新手设置开发环境并开始高效工作所需的步骤。

例如:

  • 如果您与其他贡献者组成团队,则可以针对您的项目自定义环境,然后将 .idx/dev.nix 文件提交到项目的 Git 代码库。这样,当团队成员在 Firebase Studio 中导入您的 Git 代码库时,其新的工作区将具有与您的工作区完全相同的配置,并包含相同的系统软件包、IDE 扩展程序、启动脚本等。

  • 如果您要构建框架或库供他人使用,可以在示例代码库中添加 .idx/dev.nix 文件,这样当用户将示例导入 Firebase Studio 时,就可以跳过环境设置,直接开始试用您的框架。您甚至可以构建自己的自定义模板,为用户提供一个可自定义的起点。

对环境自定义感到满意后,您可以通过向文档(例如项目的 README.md 文件)添加“在 Firebase Studio 中打开”按钮,让其他人更轻松地将您的项目导入 Firebase Studio

常见的“在 Firebase Studio 中打开”入口点

您可以使用以下几种网址格式来显示“在 Firebase Studio 中打开”按钮:

  • 如需链接到导入 Git 代码库 flow(已预先填充您的 Git 代码库网址),请使用以下网址格式:

    https://studio.firebase.google.com/import?url=https://github.com/my-org/my-repo
    

    目前,仅支持 GitHub 代码库(私有和公共)。

  • 如需连接到预定义的工作区模板,请在 Firebase Studio模板页面中找到所需的模板,然后复制其网址,该网址应遵循以下网址格式:

    https://studio.firebase.google.com/new/gemini
    
  • 如需链接到自定义模板(预填充了模板的 GitHub 网址),请使用以下网址格式:

    https://studio.firebase.google.com/new?template=https://github.com/my-org/my-template
    

添加“在 Firebase Studio 中打开”按钮

安装“在 Firebase Studio 中打开”SDK,或使用此工具为 Firebase Studio 按钮生成 HTML 文件: