pwa-generator
v1.0.13
Published
Generador de plantillas para React
Readme
📦 React PWA CLI
Generador de estructura para aplicaciones React PWA
📖 Descripción
pwa-generator es una herramienta CLI que permite crear fácilmente la estructura de archivos y carpetas para proyectos React PWA. Automatiza la configuración inicial del proyecto, incluyendo la configuración de Git, la estructura de carpetas y la conexión con un repositorio remoto.
🚀 Instalación
Para instalarlo globalmente desde npm, ejecuta:
npm install -g pwa-generator📌 Uso
Después de la instalación, puedes ejecutar el CLI con el comando:
pwa-generator <comando>🛠 Comandos Disponibles
| Comando | Descripción |
|--------------------|-------------|
| init | Crea un nuevo proyecto React PWA con la estructura base. |
| create <tipo> | Genera un nuevo componente o página dentro del proyecto. |
✅ Opciones para el comando create:
create component→ Crea un nuevo componentecreate page→ Crea una nueva página
🏗 Ejemplos de Uso
✅ Iniciar un nuevo proyecto
pwa-generator initEl CLI solicitará información como el nombre del proyecto, descripción y la opción de conectarlo a un repositorio Git.
✅ Crear una nueva página
pwa-generator create pageEl CLI preguntará el nombre de la página y generará la estructura correspondiente.
✅ Crear un nuevo componente
pwa-generator create componentEl CLI solicitará el nombre del componente y lo generará en la carpeta src/components.
📂 Estructura del Proyecto Generado
/my-pwa-project
│── src/
│ │── config/
│ │── pages/
│ │── services/
│ │── utils/
│ │── components/
│ │── theme/
│ │── root/
│── package.json
│── tsconfig.json
│── README.md
│── .gitignore
│── vite.config.ts
│── index.html
│── manifest.json🔗 Conexión con un Repositorio Git
Si especificas un repositorio durante la configuración inicial (init), el CLI:
✅ Inicializará Git
✅ Creará una rama main
✅ Agregará el repositorio remoto
Si omites esta opción, podrás configurarlo manualmente más adelante.
🖥 Abrir en Visual Studio Code
Al finalizar la creación del proyecto, el CLI preguntará si deseas abrirlo en VSCode. Puedes elegir:
🔹 Presionar ENTER → Abre el proyecto en VSCode
🔹 Escribir n y ENTER → No abrir en VSCode
📋 Requisitos
🔹 Node.js >= 14
🔹 npm >= 6
🔹 Git (opcional, solo si deseas conectar a un repositorio)
🔹 Visual Studio Code (opcional, si deseas abrir el proyecto automáticamente)
🤝 Contribución
Si deseas contribuir, sigue estos pasos:
- Fork este repositorio
- Crea una rama con tu feature (
git checkout -b feature-nueva) - Commitea tus cambios (
git commit -m "Agregada nueva feature") - Haz push a la rama (
git push origin feature-nueva) - Abre un Pull Request 🚀
📜 Licencia
Este proyecto está bajo la licencia MIT. Puedes usarlo y modificarlo libremente.
¡Gracias por usar React PWA CLI! 🎉🚀
