@mlw-packages/create-template
v1.0.7
Published
Coleção de templates e um gerador interativo para iniciar projetos rapidamente.
Readme
Grupo Malwee · templates
Coleção de templates e um gerador interativo para iniciar projetos rapidamente.
Resumo: este repositório contém templates (ex.: Next.js) e um utilitário CLI para copiar um template, ajustar o package.json e gerar um novo projeto pronto para desenvolvimento.
Principais recursos
- Gerador interativo em
bin/create-template.jspara escolher template, nome, gerenciador de pacotes e extras. - Templates prontos em
src/templates/(ex.: Next.js, Vite + React). - Suporte opcional a extras: Prisma, Husky, React Hook Form, Zod, Zustand e Docker.
Requisitos
- Node.js 18+ instalado
- Gerenciador de pacotes:
pnpm(recomendado),npmouyarn
Instalação (no repositório)
- Clone este repositório ou baixe os fontes.
- Instale dependências do próprio repositório (raiz):
pnpm install
# ou
npm installUso do gerador
O gerador interativo está em bin/create-template.js. Execute-o a partir da raiz:
node ./bin/create-template.jsO fluxo faz:
- Escolha do diretório destino (root ou nova pasta).
- Seleção do template (ex.: Next.js).
- Escolha do gerenciador de pacotes (
pnpm,npm,yarn). - Seleção opcional de extras (Prisma, Docker, Husky, Hook Form, Zod, Zustand).
- Cópia dos arquivos do template para o destino e atualização do
package.json(camponame). - (Opcional) execução automática do comando de instalação no destino.
Exemplo rápido — criar no diretório atual:
# a partir da raiz do repositório
node ./bin/create-template.jsOu criar em uma nova pasta meu-app:
node ./bin/create-template.js
# escolha "Em uma nova pasta" e informe "meu-app"Após a criação, normalmente:
cd meu-app
pnpm install # ou npm install / yarn
pnpm run dev # iniciar modo desenvolvimento conforme o templateTemplates incluídos
src/templates/next— Next.js (App Router, Tailwind, tRPC)src/templates/vite-react— Vite + React
Veja documentação do template Next em src/templates/next/README.md.
Como adicionar um novo template
- Crie
src/templates/<nome-do-template>com a estrutura do projeto base. - Inclua um
package.jsoncom scripts padrão (dev,build,start). - Adicione uma opção no prompt
Templateembin/create-template.jspara expor o novo template. - Teste executando
node ./bin/create-template.jse selecionando o template.
Dicas
- Mantenha templates enxutos e deixe configurações específicas (migrations, env) documentadas em um
README.mddentro do template.
Estrutura do repositório
bin/— utilitários CLI, incluindobin/create-template.jssrc/templates/— templates disponíveis (next,vite-react, ...)package.json— manifesto do projeto (raiz)
Arquivo gerador: bin/create-template.js
