create-exp-sq-paul-cli

Un scaffold CLI para generar proyectos de Node.js con Express, Sequelize y migraciones de forma rápida y sencilla.

🚀 Uso

Opción 1: Usar npx (Recomendado)

npx create-exp-sq-paul-cli nombre-del-proyecto

Opción 2: Instalar globalmente

npm install -g create-exp-sq-paul-cli
create-exp-sq-paul-cli nombre-del-proyecto

📋 Descripción

Este paquete npm funciona como un generador de proyectos (scaffold) que:

1. Clona automáticamente el template desde el repositorio de GitHub
2. Copia todos los archivos del template a una nueva carpeta con el nombre que especifiques
3. Muestra mensajes de progreso durante todo el proceso
4. Maneja errores de forma elegante con mensajes claros

🛠️ Qué hace internamente

Cuando ejecutas el comando, el scaffold realiza las siguientes acciones:

1. ✅ Validación: Verifica que el nombre del proyecto sea válido
2. 🔍 Verificación: Comprueba que el directorio no exista previamente
3. 📥 Clonación: Clona el repositorio template desde GitHub
4. 📁 Creación: Crea el directorio del nuevo proyecto
5. 📋 Copia: Transfiere todos los archivos del template (excluyendo .git)
6. 🧹 Limpieza: Elimina los archivos temporales
7. 📝 Instrucciones: Muestra los próximos pasos a seguir

🎯 Ejemplo de uso

# Crear un nuevo proyecto llamado "mi-proyecto"
npx create-exp-sq-paul-cli mi-proyecto

# Navegar al directorio del proyecto
cd mi-proyecto

# Instalar dependencias (si existe package.json)
npm install

# Iniciar el proyecto
npm start

📦 Características

• 🚀 Rápido: Utiliza clonación con profundidad 1 para mayor velocidad
• 🎨 Visual: Spinners y colores para una mejor experiencia de usuario
• 🛡️ Seguro: Validación de nombres y verificación de directorios existentes
• 🔧 Robusto: Manejo completo de errores con mensajes descriptivos
• 🌐 Multiplataforma: Funciona en Windows, macOS y Linux
• 🧹 Limpio: Eliminación automática de archivos temporales

📋 Requisitos

• Node.js: >= 14.0.0
• npm: >= 6.0.0
• Git: Debe estar instalado en el sistema

🔧 Dependencias

• simple-git: Para la clonación de repositorios
• fs-extra: Para operaciones avanzadas del sistema de archivos
• chalk: Para colorear la salida en terminal
• ora: Para mostrar spinners de progreso

🐛 Solución de problemas

Error de permisos

Si encuentras errores de permisos, asegúrate de tener los permisos necesarios para escribir en el directorio actual.

Error de red

Si falla la clonación, verifica tu conexión a internet y que puedas acceder a GitHub.

Directorio ya existe

El scaffold no sobrescribirá directorios existentes por seguridad. Elige un nombre diferente o elimina el directorio existente.

🤝 Contribuciones

Las contribuciones son bienvenidas. Por favor:

1. Haz un fork del proyecto
2. Crea una rama para tu feature (git checkout -b feature/nueva-funcionalidad)
3. Commitea tus cambios (git commit -am 'Agrega nueva funcionalidad')
4. Push a la rama (git push origin feature/nueva-funcionalidad)
5. Abre un Pull Request

📄 Licencia

MIT License - ve el archivo LICENSE para más detalles.

👨‍💻 Autor

Paul Zaruma - [[email protected]]

🔗 Enlaces

• Repositorio del Template
• Documentación de npm
• Guía de creación de CLI

⭐ Si este proyecto te resulta útil, ¡dale una estrella en GitHub!