阅读(242) 书签 (0)

使用 GitHub 仓库开发项目

2024-11-28 10:10 更新

本文档介绍如何通过导入 GitHub 仓库来创建项目,选择合适的开发环境模板,并在豆包 MarsCode IDE 中完成项目的初始化与运行。

使用限制

单个账号在豆包 MarsCode IDE 上创建的项目数量不得超过 10 个。

重要提示

在进行 GitHub 授权时,请确保你了解所授权的权限范围。

操作步骤

第一步:登录豆包 MarsCode IDE 工作台

前往豆包 MarsCode IDE 工作台并登录你的账号。

14-1


第二步:导入 GitHub 仓库

将 GitHub 仓库导入至豆包 MarsCode IDE 平台。支持 Github 授权导入和 Github URL 导入两种方式。

1、在工作台的欢迎页面,点击左上角的 + 项目 按钮,或点击 创建您的项目 面板处的 导入 Git 项目 按钮。

14-2


你将看到 创建项目 窗口。

14-3


2、选择 GitHub 仓库。

方式:通过关联 GitHub 账号导入

1、点击 我的代码仓库 面板处的 授权获取仓库。

14-4

你将看到 GitHub 账号授权窗口。

14-5

2、选择授权 All repositories (所有仓库) 或 Only select repositories (指定仓库)。

3、然后点击底部的 Authorize & Request 按钮。

操作完成后,返回豆包 MarsCode IDE ,“我的代码仓库” 面板中会显示已导入的仓库。

14-6


方式:通过 URL 导入

导入 URL面板中,填入一个 GitHub 公开仓库的 URL。平台会自动导入该 URL 关联的 GitHub 仓库。

提示:豆包 MarsCode IDE 不支持使用私人仓库。若填入私人仓库的 URL,输入框下方会提示 ”此代码仓库为私有仓库或无效地址,请检查“。

14-7


第三步:选择开发环境模板并创建项目

以 Vercel 的 AI 仓库为例,导入 GitHub 仓库后,平台将为该仓库自动推荐匹配的开发环境模板。

1、点击模板区域的 切换 按钮,展开模板列表,然后选择所需模板。你也可以保留默认推荐的模板。

  • 在选择开发环境模板时,确保模板与项目的开发语言相匹配。如果没有匹配项,可选择 ”All In One“  模版。
  • 若想了解模板详情,可点击模板名称右侧的 详情 按钮。

14-8

2、在 项目名称 和 项目描述 字段处,填入项目名称和项目描述。

3、点击底部的 创建 按钮。创建项目后,系统将启动并初始化项目。

14-9

初始化完毕后,你将进入工作空间。

14-10


第四步:配置项目

你可以根据项目需求,编辑文件内容、添加插件等。如果豆包 MarsCode IDE 中缺少所需的依赖,可以根据项目的具体需求,在终端面板(Terminal)中手动安装。

第五步:运行项目

根据文档教程依赖安装完成后,进入项目目录,在终端面板中手动运行项目。

14-11

第六步:体验项目

项目成功启动后,底部的 网络服务 面板会显示该项目的 URL,你可以在浏览器中打开该 URL 进行预览。关于网络服务的详细说明可参考《网络服务》一文。

14-12


打开预览 url,即可测试验证您的项目了。

14-13


Git 操作说明

MarsCode 默认已集成 Git,你可以在 IDE 中进行 Git 操作,提高开发效率。

场景一:未进行 GitHub 授权

在这种场景下,开发者尚未通过 GitHub 的 OAuth 进行授权。因此,需要手动设置 Git,以便在豆包 MarsCode IDE 中使用。详细说明可以参考 GitHub 的官方文档《Set up Git》。以下步骤是设置 Git 的关键部分:

1、在终端或命令提示符中运行 git --version 命令来检查是否已安装 Git。

2、使用以下命令配置 Git 的用户信息,包括用户姓名和电子邮件地址。这些信息将用于标识你的每次提交。

git config --global user.name "your username"
git config --global user.email "your email"

3、在终端中运行以下命令生成 SSH 密钥:

ssh-keygen -t rsa -b 4096 -C "your email"

14-14


4、按照提示完成密钥的生成,并将生成的公钥(默认位于 /home/cloudide/.ssh/id_rsa.pub)添加到 GitHub 账户的 SSH 密钥部分,详细配置参考《Adding a new SSH key to your GitHub account》。


5、运行 ​ssh -Tgit@github.com​命令,检查是否能够成功通过 SSH 连接到 GitHub。

如果消息提示你已成功认证,则说明你的 SSH 设置是正确的。

14-15

场景二:已进行 Github 授权

在已通过 GitHub 授权后,你可以直接在 IDE 中使用 Git 命令,执行各种 Git 操作。以下是使用 Git 的基本步骤:

1、在豆包 MarsCode IDE 中克隆代码。

2、进行常见的 Git 操作,如提交(commit)、推送(push)、拉取(pull)和分支(branch)管理。此外,豆包 MarsCode IDE 界面右侧的 Source Control 插件简化了 Git 操作,无需使用复杂的命令行操作。

14-16