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* " )

执照

麻省理工学院