create-nest-clean-api

CLI para crear proyectos NestJS con arquitectura hexagonal/clean architecture.

🚀 Uso Rápido

# Usando npx (recomendado)
npx create-nest-clean-api my-awesome-api

# O usando npm
npm create nest-clean-api@latest my-project

# O instalando globalmente
npm install -g create-nest-clean-api
create-nest-clean-api my-api

📋 Requisitos

• Node.js >= 20.0.0
• npm >= 10.0.0
• Git (opcional, pero recomendado)

✨ Qué hace este CLI

1. ✅ Valida prerequisitos (Node, npm versiones)
2. ✅ Descarga el template desde GitHub
3. ✅ Copia .env.example → .env
4. ✅ Personaliza package.json con el nombre de tu proyecto
5. ✅ Instala dependencias (con reintentos automáticos)
6. ✅ Inicializa Git con commit inicial
7. ✅ Limpia en caso de error (no deja archivos huérfanos)

📦 Resultado

Un proyecto NestJS completamente funcional con:

• 🏗️ Arquitectura hexagonal/cebolla
• 📖 Swagger/ReDoc/Scalar preconfigurado
• 🧪 Testing setup (Jest)
• 🎯 Módulo Health de ejemplo
• 📝 Documentación completa (SETUP.md, USAGE.md)
• 🔧 ESLint + Prettier configurados
• 🚀 Listo para npm run start:dev

🎯 Próximos Pasos

Después de crear el proyecto:

cd my-awesome-api
npm run start:dev

Visita:

• 🏥 Health Check: http://localhost:3000/health
• 📖 Swagger UI: http://localhost:3000/api/docs
• 📘 ReDoc: http://localhost:3000/api/redoc
• 🎨 Scalar: http://localhost:3000/api/scalar

🛠️ Opciones

create-nest-clean-api <nombre-proyecto>   # Crear proyecto
create-nest-clean-api --help              # Mostrar ayuda
create-nest-clean-api --version           # Mostrar versión

🐛 Problemas

Si encuentras algún error:

1. Verifica que cumples los requisitos (Node >= 20, npm >= 10)
2. Asegúrate de tener conexión a internet
3. Reporta el issue en: https://github.com/Gergab00/nest-clean-api-kit/issues

📚 Documentación

Para más información sobre la arquitectura y cómo usar el proyecto generado, consulta:

• SETUP.md
• USAGE.md
• copilot-instructions.md

📄 Licencia

MIT

👥 Autor

Gergab [email protected]