豆包MarsCode IDE：從GitHub倉(cāng)庫(kù)開(kāi)發(fā)項(xiàng)目的完整指南

本文檔介紹如何通過(guò)導(dǎo)入 GitHub 倉(cāng)庫(kù)來(lái)創(chuàng)建項(xiàng)目，選擇合適的開(kāi)發(fā)環(huán)境模板，并在豆包 MarsCode IDE 中完成項(xiàng)目的初始化與運(yùn)行。

使用限制

單個(gè)賬號(hào)在豆包 MarsCode IDE 上創(chuàng)建的項(xiàng)目數(shù)量不得超過(guò) 10 個(gè)。

重要提示

在進(jìn)行 GitHub 授權(quán)時(shí)，請(qǐng)確保你了解所授權(quán)的權(quán)限范圍。

操作步驟

第一步：登錄豆包 MarsCode IDE 工作臺(tái)

前往豆包 MarsCode IDE 工作臺(tái)并登錄你的賬號(hào)。

第二步：導(dǎo)入 GitHub 倉(cāng)庫(kù)

將 GitHub 倉(cāng)庫(kù)導(dǎo)入至豆包 MarsCode IDE 平臺(tái)。支持 Github 授權(quán)導(dǎo)入和 Github URL 導(dǎo)入兩種方式。

1. 在工作臺(tái)的歡迎頁(yè)面，點(diǎn)擊左上角的 ＋ 項(xiàng)目 按鈕，或點(diǎn)擊 創(chuàng)建您的項(xiàng)目 面板處的 導(dǎo)入 Git 項(xiàng)目 按鈕。 你將看到 創(chuàng)建項(xiàng)目 窗口。
2. 選擇 GitHub 倉(cāng)庫(kù)。

方式	步驟
通過(guò)關(guān)聯(lián) GitHub 賬號(hào)導(dǎo)入	點(diǎn)擊 我的代碼倉(cāng)庫(kù) 面板處的 授權(quán)獲取倉(cāng)庫(kù)。  你將看到 GitHub 賬號(hào)授權(quán)窗口。 選擇授權(quán) All repositories (所有倉(cāng)庫(kù)） 或 Only select repositories （指定倉(cāng)庫(kù)）。 然后點(diǎn)擊底部的 Authorize & Request 按鈕。 操作完成后，返回豆包 MarsCode IDE ，“我的代碼倉(cāng)庫(kù)” 面板中會(huì)顯示已導(dǎo)入的倉(cāng)庫(kù)。
通過(guò) URL 導(dǎo)入	在 導(dǎo)入 URL 面板中，填入一個(gè) GitHub 公開(kāi)倉(cāng)庫(kù)的 URL。平臺(tái)會(huì)自動(dòng)導(dǎo)入該 URL 關(guān)聯(lián)的 GitHub 倉(cāng)庫(kù)。  提示： 豆包 MarsCode IDE 不支持使用私人倉(cāng)庫(kù)。若填入私人倉(cāng)庫(kù)的 URL，輸入框下方會(huì)提示 ”此代碼倉(cāng)庫(kù)為私有倉(cāng)庫(kù)或無(wú)效地址，請(qǐng)檢查“。

第三步：選擇開(kāi)發(fā)環(huán)境模板并創(chuàng)建項(xiàng)目

以 Vercel 的 AI 倉(cāng)庫(kù)為例，導(dǎo)入 GitHub 倉(cāng)庫(kù)后，平臺(tái)將為該倉(cāng)庫(kù)自動(dòng)推薦匹配的開(kāi)發(fā)環(huán)境模板。

1. 點(diǎn)擊模板區(qū)域的 切換 按鈕，展開(kāi)模板列表，然后選擇所需模板。你也可以保留默認(rèn)推薦的模板。

   - 在選擇開(kāi)發(fā)環(huán)境模板時(shí)，確保模板與項(xiàng)目的開(kāi)發(fā)語(yǔ)言相匹配。如果沒(méi)有匹配項(xiàng)，可選擇 ”`All In One`“  模版。

   
   - 若想了解模板詳情，可點(diǎn)擊模板名稱右側(cè)的 詳情 按鈕。
   

2. 在 項(xiàng)目名稱 和 項(xiàng)目描述 字段處，填入項(xiàng)目名稱和項(xiàng)目描述。
3. 點(diǎn)擊底部的 創(chuàng)建 按鈕。創(chuàng)建項(xiàng)目后，系統(tǒng)將啟動(dòng)并初始化項(xiàng)目。 初始化完畢后，你將進(jìn)入工作空間。

第四步：配置項(xiàng)目

你可以根據(jù)項(xiàng)目需求，編輯文件內(nèi)容、添加插件等。如果豆包 MarsCode IDE 中缺少所需的依賴，可以根據(jù)項(xiàng)目的具體需求，在終端面板（Terminal）中手動(dòng)安裝。

第五步：運(yùn)行項(xiàng)目

根據(jù)文檔教程依賴安裝完成后，進(jìn)入項(xiàng)目目錄，在終端面板中手動(dòng)運(yùn)行項(xiàng)目。

第六步：體驗(yàn)項(xiàng)目

項(xiàng)目成功啟動(dòng)后，底部的 網(wǎng)絡(luò)服務(wù) 面板會(huì)顯示該項(xiàng)目的 URL，你可以在瀏覽器中打開(kāi)該 URL 進(jìn)行預(yù)覽。關(guān)于網(wǎng)絡(luò)服務(wù)的詳細(xì)說(shuō)明可參考《網(wǎng)絡(luò)服務(wù)》一文。

打開(kāi)預(yù)覽 url，即可測(cè)試驗(yàn)證您的項(xiàng)目了。

Git 操作說(shuō)明

MarsCode 默認(rèn)已集成 Git，你可以在 IDE 中進(jìn)行 Git 操作，提高開(kāi)發(fā)效率。

場(chǎng)景一：未進(jìn)行 GitHub 授權(quán)

在這種場(chǎng)景下，開(kāi)發(fā)者尚未通過(guò) GitHub 的 OAuth 進(jìn)行授權(quán)。因此，需要手動(dòng)設(shè)置 Git，以便在豆包 MarsCode IDE 中使用。詳細(xì)說(shuō)明可以參考 GitHub 的官方文檔《Set up Git》。以下步驟是設(shè)置 Git 的關(guān)鍵部分：

1. 在終端或命令提示符中運(yùn)行 git --version 命令來(lái)檢查是否已安裝 Git。
2. 使用以下命令配置 Git 的用戶信息，包括用戶姓名和電子郵件地址。這些信息將用于標(biāo)識(shí)你的每次提交。

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

3. 在終端中運(yùn)行以下命令生成 SSH 密鑰：

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

   

4. 按照提示完成密鑰的生成，并將生成的公鑰（默認(rèn)位于 /home/cloudide/.ssh/id_rsa.pub）添加到 GitHub 賬戶的 SSH 密鑰部分，詳細(xì)配置參考《Adding a new SSH key to your GitHub account》。
5. 運(yùn)行 ssh -T git@github.com命令，檢查是否能夠成功通過(guò) SSH 連接到 GitHub。

如果消息提示你已成功認(rèn)證，則說(shuō)明你的 SSH 設(shè)置是正確的。

場(chǎng)景二：已進(jìn)行 Github 授權(quán)

在已通過(guò) GitHub 授權(quán)后，你可以直接在 IDE 中使用 Git 命令，執(zhí)行各種 Git 操作。以下是使用 Git 的基本步驟：

1. 在豆包 MarsCode IDE 中克隆代碼。
2. 進(jìn)行常見(jiàn)的 Git 操作，如提交（commit）、推送（push）、拉取（pull）和分支（branch）管理。此外，豆包 MarsCode IDE 界面右側(cè)的 Source Control 插件簡(jiǎn)化了 Git 操作，無(wú)需使用復(fù)雜的命令行操作。