DKCutter Next.js • Nicolas Contiero

Desenvolvido por DKCutter, o DKCutter Next.js é um framework para iniciar rapidamente projetos Next.Js.

Se você tiver problemas com o DKCutter Next.js, abra uma issue.

Uso

Para estruturar um aplicativo usando o dkcutter, execute qualquer um dos quatro comandos a seguir e responda às perguntas do prompt de comando:

npm

terminal

npx dkcutter gh:ncontiero/dkcutter-nextjs.git

yarn

terminal

yarn dlx dkcutter gh:ncontiero/dkcutter-nextjs.git

pnpm

terminal

pnpm dlx dkcutter gh:ncontiero/dkcutter-nextjs.git

bun

terminal

bunx dkcutter@latest gh:ncontiero/dkcutter-nextjs.git

Você será solicitado a fornecer alguns valores. Forneça-os e um projeto Next.Js será criado para você.

Aviso: Após este ponto, altere "author name", etc. para suas próprias informações.

Responda aos prompts com suas próprias opções desejadas. Por exemplo:

terminal

✔ What is the project name? … My Awesome Project
✔ What is the project slug? … my-awesome-project
✔ What is the project description? … Behold My Awesome Project!
✔ What is the author name? … Nicolas Contiero <https://github.com/ncontiero>
✔ What is the project version? … 0.1.0
✔ Do you want to use husky? … No / Yes
✔ Do you want to use lint staged? … No / Yes
✔ Do you want to use Commitlint? … No / Yes
✔ Do you want to use Next.Js app folder? … No / Yes
✔ What database ORM would you like to use? › None
✔ What Authentication Provider would you like to use? › None
✔ What Automated Dependency Updater do you want to use? › Mend Renovate
✔ Do you want the project to be configured? … No / Yes
Next steps:
  cd my-awesome-project
  pnpm install
  git add .
  git commit -m "initial commit"
  pnpm dev
 
✔ Project created!

Entre no projeto e dê uma olhada:

terminal

cd my-awesome-project/
ls

Agora dê uma olhada no seu repositório. Não se esqueça de ler atentamente o README gerado.

Uso avançado

Se você quiser começar mais rápido, pode usar as seguintes opções:

Flag	Descrição
`--projectName <string>`	O nome do projeto.
`--projectSlug <string>`	O Slug do Projeto.
`--description <string>`	A descrição do projeto.
`--authorName <string>`	O nome do autor.
`--projectVersion <string>`	A versão do projeto.
`--useHusky [boolean]`	Inclui o husky no projeto.
`--useLintStaged [boolean]`	Inclui o lint-staged no projeto.
`--useCommitlint [boolean]`	Inclui o commitlint no projeto.
`--useAppFolder [boolean]`	Usa a estrutura da pasta de aplicativos do Next.Js.
`--database <string>`	Escolha um ORM de banco de dados. Veja para mais informações.
`--useDockerCompose [boolean]`	Inclui o docker compose no projeto para o banco de dados. Se `database` for diferente de `none`.
`--authProvider <string>`	Escolha um provedor de autenticação. Veja para mais informações.
`--clerkWebhook [boolean]`	Inclui um endpoint para receber eventos do Clerk.
`--automatedDepsUpdater <string>`	Escolha o Atualizador de Dependências Automatizado. Veja para mais informações.
`--automaticStart [boolean]`	Esta opção instalará os pacotes do aplicativo, iniciará um repositório git e fará o commit inicial.

Veja mais informações sobre as opções.

Exemplo

A seguir, a estrutura de um aplicativo com o Commitlint:

terminal

pnpm dlx dkcutter https://github.com/ncontiero/dkcutter-nextjs.git --useCommitlint

Se você quiser usar todos os valores padrão, com exceção de um ou mais, pode fazer da seguinte forma:

terminal

pnpm dlx dkcutter https://github.com/ncontiero/dkcutter-nextjs.git --useHusky --useLintStaged -y

Isso usará os valores padrão, com exceção das opções --useHusky e --useLintStaged.

Veja mais informações no repositório do github: ncontiero/dkcutter-nextjs.