用 Rayfin CLI 建立一個 Fabric 應用程式

這個教學會教你如何使用 Rayfin CLI 建立專案、本地執行,然後部署到 Microsoft Fabric。 你用同一套 CLI 工作流程來處理新應用程式,以及後續的架構或前端更新。

在本教學課程中,您會:

  • 從範本建立一個 Fabric Apps 專案。
  • 在本地啟動應用程式。
  • 從 CLI 登入 Microsoft Fabric。
  • 將應用程式部署到 Fabric 工作區。
  • 確認部署狀態。

先決條件

  • Microsoft Fabric 的存取權。
  • 一個 Fabric 工作區,你擁有貢獻者、成員或管理員權限。
  • 你的租戶已啟用 Fabric Apps 工作負載。
  • Node.js 和 NPM 已安裝。

如果 Fabric Apps 工作負載尚未啟用,請 Fabric 系統管理員在 Fabric 管理入口網站中啟用 Fabric Apps (preview)

步驟 1:建立新的專案

要從範本搭建新應用程式,請使用 npm create

npm create @microsoft/rayfin@latest -- my-app --workspace <workspacename>

此指令會建立一個新的專案資料夾,包含應用程式範本、設定檔 rayfin 及前端原始碼。

前往專案目錄:

cd my-app

小提示

如果你已經有空的專案資料夾或現有的原始碼,請用 npx rayfin init 代替 npm create

npx rayfin init .

步驟二:檢視已產生的專案

支架完成後,專案包含你需要開始開發的檔案:

  • rayfin/rayfin.yml 儲存應用程式服務與部署設定。
  • rayfin/.env 儲存 CLI 所使用的環境值。
  • rayfin/data/ 包含你的資料模型檔案。
  • 你的前端應用程式會儲存在所選範本所建立的根專案結構中。

如需詳細的逐檔案分解,請參閱 「了解專案結構」。

步驟 3:在本地執行應用程式

啟動在地發展環境:

npm run dev

此指令啟動支架應用的前端開發伺服器,並將後端部署至 Fabric。 要確認應用程式是否正確啟動,請在終端機中開啟本地網址。

步驟 4:將應用程式部署到 Fabric

在你的應用程式中加入更多功能。 測試完變更後,再部署到 Fabric。

npx rayfin up

若要預覽部署而不做更改,請執行:

npx rayfin up --dry-run

步驟五:驗證部署

請檢查目前的部署狀態:

npx rayfin up status

若要取得機器可讀的回應,請使用 JSON 輸出:

npx rayfin up status --json

成功部署後,CLI 會列印已部署項目的託管應用程式 URL 及 Fabric 入口連結。

步驟 6:僅部署資料庫或靜態內容

如果你只更改了資料模型,請在不完全重新部署的情況下套用資料庫變更:

npx rayfin up db apply

如果你只改了前端程式碼,請重新部署靜態資產:

npx rayfin up staticapp deploy

排除常見問題

登入失敗,或部署時傳回 401 或 403 錯誤

再跑 npx rayfin login 一次,然後再試 npx rayfin up一次。

你需要檢視 CLI 會執行什麼動作

在部署變更前,先執行 npx rayfin up --dry-run

應用程式會部署,但你只改變了架構

若要獨立推送結構變更,請使用 npx rayfin up db apply。 如果你執行破壞性變更,例如更改欄位類型或移除欄位,這個指令就會失敗。 若要強制套用你的變更,你可以使用 --force 旗標。 這個動作可能會帶來突破性改變。

下一步