kirimase

Observação

Nota: Apenas bugs críticos estão sendo abordados agora, pois estamos planejando uma reescrita completa em um futuro muito próximo!

Kirimase

Kirimase é uma ferramenta de linha de comando para criar aplicativos de palha completa . Ele sobrecarrega seu fluxo de trabalho de desenvolvimento, permitindo que você integre rapidamente pacotes e recursos de andaime para o seu aplicativo com as melhores práticas em mente.

Assista a demonstração mais recente aqui

Confira o tutorial oficial aqui

Características

1. Inicialização e configuração : Adicione e configure rapidamente pacotes essenciais para iniciar seu projeto Next.js.
2. Geração de código : modelos, visualizações e controladores de andaimes diretamente da CLI.

Início rápido

Instale a Kirimase CLI globalmente:

npm install -g kirimase

Se você ainda não possui um aplicativo NextJS, execute o Create-Next-App com seu gerenciador de pacotes preferido.

Em seguida, execute o seguinte comando dentro do diretório do seu projeto:

kirimase init

NOTA: A kirimase não é compatível com o diretório das páginas.

Comandos

Execute esses comandos no diretório do seu próximo aplicativo:

1. kirimase add

Inicializa e configura os seguintes pacotes para o seu projeto Next.js, categorizado em:

Orm

Regue-se

• Com base no tipo de banco de dados escolhido (PostgreSQL, MySQL, SQLite), a Kirimase configura os arquivos necessários para garoa-are, garoa-zod para validações e e garoto-kit para gerenciar migrações.
• Os scripts são adicultores automáticos para package.json para uso imediato de garoto-kit.

Prisma

• A Kirimase configura arquivos necessários para prisma com Zod-Prisma para validações.

---

Autenticação

Auth.js

• Gera arquivos para o auth.js (Next-Auth), incluindo o mais recente adaptador de garoa. (Para a escala de planetas, as referências são excluídas, pois não suporta chaves estrangeiras).
• Gera um componente de login genérico para uso imediato no seu projeto Next.js.
• Envolva o layout da raiz com o provedor de autenticação e gera utilitários para verificações e redirecionamentos de autenticação em suas próximas rotas.

Atendente

• Gera arquivos para o funcionário, incluindo toda a configuração necessária.
• Envolva o layout da raiz com o provedor de autenticação e gera utilitários para verificações e redirecionamentos de autenticação em suas próximas rotas.

Lucia

• Gera arquivos para Lucia, incluindo toda a configuração necessária.
• Gera rotas de interface do usuário e API para inscrição e inscrição

Meio

• Gera arquivos para o tipo, incluindo toda a configuração necessária.
• Gera assinatura no componente e manipulador de rota

---

Outro

TRPC

• Gera arquivos para configurar o TRPC com o roteador de aplicativos.
• Fornece a configuração do lado do servidor TRPC e andaimes do lado do cliente usando o padrão experimental do servidor-invoker.
• Envolva o layout da raiz no provedor TRPC.

Shadcn-ui

• Instala e configura Shadcn-Ui, incluindo componentes de botão e torrada.
• Insira o provedor de torradas ( <Toaster /> ) no layout da raiz para notificações instantâneas de brinde no seu aplicativo Next.js.

Listra

• Instala e configura o Stripe no seu projeto Next.js para que você possa começar a aceitar pagamentos de assinatura.

Reenviar

• Instala e configura reenviar

A Kirimase também adiciona teclas relevantes ao seu .env para as quais você precisará fornecer valores.

2. kirimase generate

Semelhante ao rails scaffold , mas para Next.js:

Kirimase gera:

a) Modelo:

• Gera um esquema de garoa com tipos de colunas com base no seu provedor de sabores e banco de dados SQL.
• Usa a garoa-zod para gerar esquemas ZOD para validação de front-end e back-end.
• Gera consultas e mutações para operações de CRUD, totalmente digitadas e otimizadas para consumo por meio de um próximo.js front-end.

b) Controlador:

• Dá a você a opção de TRPC, ações do servidor e/ou rotas de API.
• Usa os esquemas do ZOD dos modelos para validação de solicitação.
• Inclui tratamento de erros interno para rotas de API e adição automática de rotas TRPC para o roteador raiz.

c) visualizações:

• Visualizações de andaimes usando o shadcn-ui para ativar operações imediatas do CRUD (incluindo campos selecionados para adicionar relações e datepickers para datas).
• Opção para usar o react gancho de forma com TRPC ou reação simples (usetimistics e use Validated Form Hooks)

Executar em modo não interativo

A partir da v0.0.23, você pode executar kirimase init e kirimase add inteiramente através da linha de comando da seguinte forma:

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

Comando	Bandeira curta	Opção longa	Descrição	Argumento
init	-	-	inicializar e configurar a kirimase	-
-	-h	--sem cabeça	inicialize sem qualquer interface do usuário	yes ou no
-	-sf	--SRC-Folder	Use uma pasta SRC	yes ou no
-	-pm	-Package-manager	Gerente de pacotes	<pm>
-	-cl	--componente-lib	Biblioteca de componentes	<component-lib>
-	-o	--orm	orm	<orm>
-	-db	--db	banco de dados ("pg", "mysql", "sqlite")	<db>
-	-dbp	--db-provider	Provedor de banco de dados - importante se estiver usando garoa	<dbp>
-	-um	--auth	Auth	<auth>
-	-Ap	--auth-providers	provedores de autenticação (se estiver usando a próxima-autha)	<providers>
-	-mp	-Misc-packages	pacotes ("trpc", "shadcn-ui", "reenvie")	<packages>
-	-ie	--include-expler	inclua exemplo	yes ou no

Contribuindo

Desenvolvimento de melhorar a kirimase? Contribuições, relatórios de bugs e solicitações de recursos são sempre bem -vindos. Sinta -se à vontade para abrir um problema ou enviar uma solicitação de tração.

Para executar localmente:

pnpm i
pnpm run dev

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

Licença

Mit