kirimase

筆記

注意：由於我們計劃在不久的將來進行完整的改寫，因此目前只有關鍵的錯誤正在解決！

基里米酶

Kirimase是用於構建全堆棧Next.js應用程序的命令行工具。它可以增強您的開發工作流程，從而使您可以快速將包裝和腳手架資源與最佳實踐集成在一起。

在這裡觀看最近的演示

在此處查看官方教程

特徵

1. 初始化和配置：快速添加並設置必需軟件包，以開始您的下一個項目。
2. 代碼生成：直接來自CLI的腳手架模型，視圖和控制器。

快速開始

全球安裝Kirimase CLI：

npm install -g kirimase

如果您還沒有NextJS應用程序，請使用首選的軟件包管理器運行Create-Next-App。

然後在項目目錄中運行以下命令：

kirimase init

注意：Kirimase與頁面目錄不兼容。

命令

在您的NextJS應用程序的目錄中運行這些命令：

1。 kirimase add

初始化並為您的下一個項目配置以下軟件包，分為：

ORM

毛毛雨

• 基於您選擇的數據庫類型（PostgreSql，MySQL，SQLite），Kirimase設置了毛毛雨-Orm，Drizzle-ZOD的所需文件，用於驗證的毛毛zod，以及用於管理遷移的毛毛雨。
• 腳本被自動添加到package.json中。

Prisma

• Kirimase用Zod-Prisma設置了Prisma所需的文件以進行驗證。

---

驗證

auth.js

• 生成auth.js（Next-auth）的文件，包括最新的毛毛調整適配器。 （對於Planetscale，由於不支持外國密鑰而被排除在外）。
• 生成一個通用登錄組件，供下一個項目中立即使用。
• 將根佈局與Auth Provider包裹，並在下一個路由中生成用於驗證檢查和重定向的實用程序。

文員

• 為文員生成文件，包括所有必要的配置。
• 將根佈局與Auth Provider包裹，並在下一個路由中生成用於驗證檢查和重定向的實用程序。

露西亞

• 為Lucia生成文件，包括所有必要的配置。
• 生成UI和API路由以登錄和註冊

親切

• 生成對Kinde的文件，包括所有必要的配置。
• 在組件和路由處理程序中生成符號

---

其他

trpc

• 生成使用應用程序路由器配置TRPC的文件。
• 提供客戶端TRPC和腳手架服務器端配置，使用實驗服務器評估模式。
• 將根佈局包裹在TRPC提供商中。

shadcn-ui

• 安裝和配置ShadCN-UI，包括按鈕和吐司組件。
• 將Toast-Provider（ <Toaster /> ）插入到sext.js應用中的即時吐司通知的根佈局中。

條紋

• 在您的下一個項目中安裝和配置條紋。您可以開始接受訂閱付款。

重新發出

• 安裝和配置重新啟動

Kirimase還為您的.env添加了相關鍵，您需要為其提供值。

2。 kirimase generate

類似於rails scaffold但在Next.js中：

kirimase生成：

a）模型：

• 根據您的SQL風味和數據庫提供商生成帶有列類型的細雨架構。
• 使用毛毛雨ZOD生成ZOD模式進行前端和後端驗證。
• 生成用於CRUD操作的查詢和突變，並通過Next.js前端進行完全鍵入和優化，以供消費。

b）控制器：

• 為您提供腳手架TRPC，服務器操作和/或API路由的選項。
• 使用來自模型的ZOD模式進行請求驗證。
• 包括用於API路由的內置錯誤處理以及將TRPC路由的自動添加到根路由器上。

c）視圖：

• 使用ShadCN-UI查看腳手架來啟用立即的CRUD操作（包括用於添加關係的選擇字段和日期點）。
• 使用trpc或普通react（使用鉤子和使用驗證形式的鉤子）使用React Hook表單的選項

以非交互模式運行

從v0.0.23開始，您可以運行kirimase init和kirimase add如下：

kirimase init -sf yes -pm bun --orm prisma -db pg -a next-auth -ap github discord -mp trpc stripe resend -cl shadcn-ui -ie yes

命令	短旗	長選項	描述	爭論
init	-	-	初始化和配置基里匹酶	-
-	-h	- 無頭	無UI的初始化	yes還是no
-	-sf	-src-folder	使用SRC文件夾	yes還是no
-	-下午	- 包裝經理	軟件包管理器	<pm>
-	-cl	- 組件lib	組件庫	<component-lib>
-	-o	-Orm	ORM	<orm>
-	-db	-db	數據庫（“ pg”，“ mysql”，“ sqlite”）	<db>
-	-dbp	-DB-Provider	數據庫提供商 - 重要如果使用毛毛雨	<dbp>
-	-一個	- 作物	auth	<auth>
-	-ap	- 執行者	身份驗證提供商（如果使用Next-auth）	<providers>
-	-mp	- 米斯包裝	包（“ Trpc”，“ Shadcn-UI”，“ repented”）	<packages>
-	-IE	- 包括示例	包括示例	yes還是no

貢獻

熱衷於增強基里匹酶嗎？始終歡迎貢獻，錯誤報告和功能請求。隨時打開問題或提交拉動請求。

在本地運行：

pnpm i
pnpm run dev

npm install -g . (in a second terminal - this will then make kirimase available across your machine using " kirimase *command* " )

執照

麻省理工學院