kirimase

Примечание

Примечание: сейчас рассматриваются только критические ошибки, так как мы планируем полную переписывание в ближайшем будущем!

Киримасе

Kirimase-это инструмент командной строки для строительства приложений Next-Stack Next.js быстрее . Он оттолкнул ваш рабочий процесс разработки, позволяя быстро интегрировать пакеты и ресурсы для каркасов для вашего приложения с учетом лучших практик.

Смотрите самую последнюю демонстрацию здесь

Проверьте официальный учебник здесь

Функции

1. Инициализация и конфигурация : быстро добавьте и настройте основные пакеты, чтобы начать свой проект следующего.js.
2. Генерация кода : модели каркасов, представления и контроллеры непосредственно из CLI.

Быстрый старт

Установите Kirimase CLI во всем мире:

npm install -g kirimase

Если у вас еще нет приложения NextJS, запустите Create-Next-App с вашим предпочтительным менеджером пакетов.

Затем запустите следующую команду в каталоге вашего проекта:

kirimase init

Примечание. Киримазе не совместим с каталогом страниц.

Команды

Запустите эти команды в каталоге вашего приложения NextJS:

1. kirimase add

Инициализируют и настраивают следующие пакеты для вашего проекта Next.js, категориально классифицируется на:

Орм

Дождь

• На основе выбранного вами типа базы данных (PostgreSQL, MySQL, SQLite) Kirimase устанавливает необходимые файлы для мороробогобра, моросящего за виды для проверки и моропо-KIT для управления миграциями.
• Сценарии автоматически добавлены в package.json для немедленного использования мороропинку.

Призма

• Kirimase устанавливает необходимые файлы для Prisma с Zod-Prisma для проверки.

---

Аутентификация

Auth.js

• Генерирует файлы для auth.js (next-auth), включая последний адаптер мороженного моря. (Для Planetscale ссылки исключены, поскольку они не поддерживают иностранные ключи).
• Генерирует общий компонент входа для немедленного использования в вашем проекте Next.js.
• Объединяет макет корня с помощью поставщика AUTH и генерирует утилиты для проверки AUTH и перенаправления на ваших маршрутах.

Клерк

• Генерирует файлы для клерка, включая все необходимые конфигурации.
• Объединяет макет корня с помощью поставщика AUTH и генерирует утилиты для проверки AUTH и перенаправления на ваших маршрутах.

Люсия

• Генерирует файлы для Люсии, включая все необходимые конфигурации.
• Генерирует маршруты пользовательского интерфейса и API для входа и регистрации

Вроде

• Генерирует файлы для своего, включая все необходимые конфигурации.
• Генерирует подпись в компоненте и обработчике маршрута

---

Другой

TRPC

• Генерирует файлы для настройки TRPC с маршрутизатором приложения.
• Обеспечивает конфигурацию на стороне сервера на стороне клиента и каркас Scaffolds, используя экспериментальный шаблон сервера-инвокера.
• Объединяет макет корня в поставщике TRPC.

Shadcn-Ui

• Устанавливает и настраивает Shadcn-UI, включая кнопки и тосты.
• Вставьте тост-провален ( <Toaster /> ) в макет корня для мгновенных уведомлений о тосте в вашем приложении healh.js.

Полоса

• Устанавливает и настраивает полосу в вашем проекте Next.js, чтобы вы могли начать принимать подписку.

Приезжать

• Устанавливает и настраивает повторную работу

Kirimase также добавляет соответствующие ключи к вашему .env , для которого вам необходимо предоставить значения.

2. kirimase generate

Сродни rails scaffold , но для Next.js:

Киримазе генерирует:

а) Модель:

• Генерирует схему моросящего морось с типами столбцов на основе вашего вкуса SQL и поставщика базы данных.
• Использует моропик-зод для создания схемы ZOD для проверки Frontend и Backend.
• Генерирует запросы и мутации для операций CRUD, полностью напечатанные и оптимизированные для потребления через фронт.

б) контроллер:

• Предоставляет вам возможность для каркаса TRPC, серверных действий и/или маршрутов API.
• Использует схемы ZOD из моделей для проверки запроса.
• Включает встроенное обработку ошибок для маршрутов API и автоматическое отображение маршрутов TRPC на корневой маршрутизатор.

в) представления:

• Просмотры каркасов с использованием Shadcn-UI для обеспечения немедленных операций CRUD (включая Select Fields для добавления отношений и датчиков для дат).
• Возможность использования либо формы React Chook с TRPC или Plain React (userSoptimistic и Usevalidated Form Clocks)

Запустить в неинтерактивном режиме

По состоянию на 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

Командование	Короткий флаг	Длинный вариант	Описание	Аргумент
инициатор	-	-	Инициализировать и настраивать kirimase	-
-	-час	-Без головой	Инициализировать без какого -либо пользовательского интерфейса	yes или no
-	-сф	--src-folder	Используйте папку SRC	yes или no
-	-pm	-Пэкадж-Манеджер	Менеджер пакетов	<pm>
-	-л	-Компонент-Либ	библиотека компонентов	<component-lib>
-	-О	-ор	Орм	<orm>
-	-db	-ДБ	База данных ("pg", "mysql", "sqlite")	<db>
-	-dbp	-DB-провайдер	Поставщик базы данных - важен при использовании дождей	<dbp>
-	-а	-Аут	аут	<auth>
-	-ap	-Auth-Providers	AUTR Providers (если использовать следующее-авто)	<providers>
-	-mp	-Misc-Packages	Пакеты ("trpc", "shadcn-ui", "Resend")	<packages>
-	-ie	-Include-example	Включите пример	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* " )

Лицензия

Грань