Project IDX 提供基于云的协作开发环境,可通过几乎无限的框架和库组合简化应用构建流程。
设置 IDX 工作区后,您可以几秒钟内与团队共享功能齐全、灵活的开发环境:IDX 工作区可通过任何设备访问,并配备集成工具来简化开发流程。
可以按以下步骤开始操作:
准备工作
开始之前,您可能需要为浏览器启用第三方 Cookie。Project IDX 要求在大多数浏览器中使用第三方 Cookie 来对工作区进行身份验证。
Chrome
- 打开设置。
- 打开隐私和安全标签页。
- 确保已启用允许所有 Cookie。
- 打开 idx.google.com。
- 点击地址栏中的可见性图标 visibility_off 以打开跟踪保护面板。开启第三方 Cookie 设置,以暂时允许第三方 Cookie。这会在 90 天内在 IDX 上启用 Cookie。
Safari
- 依次打开 Safari > 设置...。
- 关闭以下设置:
- 高级 > 阻止所有 Cookie
- 隐私 > 阻止跨网站跟踪
- 打开 idx.google.com。
Firefox
您无需为 Firefox 启用第三方 Cookie。前往 idx.google.com。
Opera
- 打开 idx.google.com。
- 打开菜单,然后点击设置。
- 前往隐私和安全部分,然后展开第三方 Cookie 选项。
- 选择在无痕模式下阻止第三方 Cookie或允许第三方 Cookie。
- 打开 idx.google.com。
弧形
- 前往 arc://settings。
- 前往隐私和安全部分,然后展开第三方 Cookie 选项。
- 选择在无痕模式下阻止第三方 Cookie或允许第三方 Cookie。
- 打开 idx.google.com。
Brave
您无需为 Brave 启用第三方 Cookie。前往 idx.google.com。
设置 IDX
如果这是您首次使用 IDX,则需要初始化 IDX。如果您已通过当前账号使用过 IDX,则可以继续创建工作区。
如需首次设置 IDX,请执行以下操作:
打开 Project IDX。
首次打开 IDX 时,系统会提示您阅读并接受服务条款。
查看《Google 服务条款》和《Android SDK 条款及条件》,如果您同意,请选中我同意《Google 服务条款》和《Android SDK 条款及条件》复选框。
(可选)选择接收产品动态和通告,以及参与调研,以便我们改进 IDX。
当系统提示您启用 AI 功能时,请执行以下操作:
如需在 IDX 中为所有工作区设置 AI 辅助功能,请点击启用 AI 功能。查看有关 AI 和隐私权的备注,然后点击继续以启用 AI 功能并打开 IDX,或点击返回。
如需推迟 AI 帮助,请点击以后再说。
系统会加载 IDX 信息中心。现在,您可以创建工作区了。
创建工作区
IDX 中的工作区是一个开发环境,包含开发应用所需的一切。它包含您的代码、代码编辑器(包含与您的项目相关的插件)以及支持应用开发的工具链。这就像在本地桌面开发环境中创建新项目一样,只不过您有一部预配置的计算机和操作系统,专门用于专门构建应用,该应用在云端的浏览器中运行,您可以随时随地访问。
Project IDX 工作区经过优化,可包含单个代码库,以便您将不同应用的环境和系统级依赖项彼此隔离。您可以创建多个工作区,以便与不同的应用和框架搭配使用。
如需创建新工作区,请按以下步骤操作:
打开 Project IDX。
确定要使用哪种方法初始化新工作区。如果您要构建新应用,可以使用以下方法快速创建新的工作区:
官方模板
您可以按应用类型浏览模板,也可以使用右上角的搜索框按关键字过滤整个模板库。空白工作区模板位于其他类别中。
输入工作区的名称,然后设置任何其他选项。
点击创建。IDX 会根据您选择的模板创建一个新工作区。
我们会不断添加新的模板,因此请经常回来查看,或告诉我们您希望看到哪些模板。
Git 代码库导入
社区模板
- 找到要使用的社区模板,然后复制其网址。
构建一个采用以下格式的可立即打开的 Project IDX 网址:
https://idx.google.com/new?template=TEMPLATE_URL
例如,如果您想使用 Three.js React 模板创建一个新的工作区,则可以使用以下网址:
https://idx.google.com/new?template=https://github.com/project-idx/community-templates/tree/main/threejs-react
点击创建。IDX 会根据您引用的模板创建一个新工作区。
配置工作区
IDX 使用 Nix 为每个工作区定义环境配置。Nix 是一个纯粹的功能型软件包管理器,会为每个依赖项分配唯一标识符,这最终意味着您的环境可以无缝地包含同一依赖项的多个版本。它还具有可重现性和声明性。在 IDX 上下文中,这意味着您可以在工作区之间共享 Nix 配置文件,以加载相同的环境配置。详细了解 Nix + IDX。
创建或修改 .idx/dev.nix
文件
环境配置在代码库的 .idx/dev.nix
文件中定义。此文件指定要添加到工作区的所有组件,包括:
Nix 软件包注册库中提供的系统工具,包括编译器、软件包(例如
go
或angular
)和命令行实用程序,例如额外的 gcloud CLI 组件。OpenVSX 注册库中的 IDE 扩展程序,例如特定于语言的调试程序、代码格式设置程序、适用于云服务的官方扩展程序等。
如需查看用于在 IDX 中启用应用预览的基本工作区环境配置,请参阅以下 .idx/dev.nix
文件示例:
{ pkgs, ... }: {
# Which nixpkgs channel to use.
channel = "stable-23.11"; # or "unstable"
# Use https://search.nixos.org/packages to find packages
packages = [
pkgs.nodejs_18
];
# Sets environment variables in the workspace
env = {
SOME_ENV_VAR = "hello";
};
# Search for the extensions you want on https://open-vsx.org/ and use "publisher.id"
idx.extensions = [
"angular.ng-template"
];
# Enable previews and customize configuration
idx.previews = {
enable = true;
previews = {
web = {
command = [
"npm"
"run"
"start"
"--"
"--port"
"$PORT"
"--host"
"0.0.0.0"
"--disable-host-check"
];
manager = "web";
# Optionally, specify a directory that contains your web app
# cwd = "app/client";
};
};
};
}
应用新配置
每当您添加或更新 dev.nix
配置文件时,IDX 都会在右下角显示一条提示,提示您重新构建环境。重新构建环境所需的时间取决于您的配置所需的软件包数量。
调试环境构建失败
由于配置文件是机器可读的代码,因此可能会出现错误。如果发生这种情况,环境可能无法构建和启动。IDX 会显示用于启动恢复环境的选项。此工作区不包含您定义的任何配置,只会运行基本 Code OSS。这样,您就可以修复 dev.nix
配置文件中的错误并重新构建环境。
IDX 最终会显示环境构建错误。目前,您必须自行排查问题。