官方範本

Restorm 維護一套 官方範本，您可以直接從範本庫 使用它們。您也可以從其中之一出發，把它 fork 並按您的慣例進行調整。

官方目錄

官方範本發布在 GitHub 組織 Monsieur-Dev 之下：

範本	目標	儲存庫
REST 伺服器 · TypeScript	REST · TypeScript · Express	restorm-template-server-rest-typescript
REST 伺服器 · .NET	REST · C# · ASP.NET Core	restorm-template-server-rest-dotnet
gRPC 伺服器 · TypeScript	gRPC · TypeScript	restorm-template-server-grpc-typescript
gRPC 伺服器 · .NET	gRPC · C# / .NET	restorm-template-server-grpc-dotnet
PostgreSQL 資料庫	SQL · PostgreSQL	restorm-template-db-postgres

遠端範本會作為一個 封存檔 取得（從不用 git 複製），並帶有安全防護欄和封頂的 大小。

組織範本（Enterprise）

使用 Enterprise 訂閱的組織擁有一個 私有 的範本目錄，在組織成員之間共享。 它們出現在庫中的 Templates <組織> 分頁裡，與官方範本並列。

• 誰可以新增或移除：組織的一個 管理員，或一個被管理員授予 管理範本 權限的成員。
• 如何操作：從庫的 Templates <組織> 分頁（新增 按鈕 —— 儲存庫 URL 和一段描述），或從組織的 管理儀表板。
• 它是什麼：一個組織範本只是一個 指向 git 儲存庫的指標（就像官方範本一樣）； 它的結構與下面描述的相同，但其可見性被限制在組織成員範圍內。

Community 和 Pro 版本能看到官方範本，並可以使用它們自己的範本（儲存庫 或 本機資料夾）—— 程式碼生成在所有版本中都是免費的。而共享的 組織 範本 則專屬於 Enterprise 版本。

一個自訂範本的結構

一個 Restorm 範本是一個用資訊清單增強過的 Cookiecutter/Copier 範本：

• restorm-template.json —— 位於儲存庫的 根目錄（必需）。它描述範本，並宣告 它所消費的 變數（參見生成變數）。它還宣告它所 支援的 上下文版本：一個不宣告與應用程式相容版本的範本會被拒絕。
• copier.yml（或 copier.yaml）—— Copier 設定，其中尤其宣告了生成時提出的 問題。
• 範本的檔案，以 .jinja 為後綴，用設計的上下文渲染。

要使用一個自訂範本，請在庫中選擇來源 儲存庫（GitHub 上的 owner/name）或 本機資料夾（在您開發它期間）。

Note

想向社群提交一個範本？官方範本的貢獻規則記錄在 Restorm 應用程式的儲存庫中 （docs/contributing）。