dazmoob / brok-guten-blocks

Repositorio de desarrollo de bloques de Gutenberg para WordPress

📦 brok-guten-blocks

brok-guten-blocks es un kit de desarrollo creado por mowomo.com con ❤️ para el desarrollo de bloques de Gutenberg, el nuevo editor de WordPress.

Brok Guten Blocks nació como solución a no encontrar ningún kit de desarrollo de bloques de Gutenberg capaz de ofrecer potencia y a la vez estabilidad. Una estabilidad que obtiene al ser un proyecto actualizado día a día y que se utiliza constantemente en las oficinas de mowomo para realizar proyectos de gran envergadura.

Además, está enfocado a ser usado por la comunidad de habla hispana, por lo que todos los comandos y documentación interna estarán en castellano.

brok-guten-blocks es, en resumen:

• 🐆 Ágil

• 🐘 Estable

• 🐝 Actualizado

• 🐂 Español

• 🦅 Dependencia mínima

🚀 Empezando

Empezar a trabajar con brok-guten-blocks es muy sencillo. Te dejamos aquí los pasos:

1. Clonar este repositorio donde quieras.

2. Ejecutar el comando npm install para configurar el proyecto por primera vez.

Una vez hecho esto, podrás usar ya los comandos que te ofrece brok-guten-blocks para administrar tus bloques, los cuales te dejamos explicados justo abajo.

👨‍💻 Comandos

Este paquete contiene algunos comandos de consola personalizados creados para facilitar la administración tanto de los bloques como del plugin. Una lista de ellos es:

🤙 npm start

• Usado para trabajar con el kit en sí mismo.

• Ejecútalo siempre que estés desarrollando bloques, ya que se encarga de que todo el código se vaya compilando y corrigiendo.

🤙 npm run crear "nombre-bloque"

• Usado para generar un nuevo bloque con el nombre indicado.

• El bloque creado estará correctamente configurando dentro del entorno del plugin.

🤙 npm run borrar "nombre-bloque"

• Usado para borrar un bloque con el nombre indicado.

• El bloque borrado será correctamente desconfigurado del entorno del plugin.

🤙 npm run exportar

• Usado para configurar un plugin perfectamente funcional en la carpeta exports.

• Para usarlo como plugin solo tendrás que pasarlo a la carpeta plugins de la instalación WordPress que quieras y activarlo.

📚 Dependencias mínimas

Este kit de desarrollo se basa en ciertas dependencias que, de no estar incluidas, no funcionaría correctamente. Te hacemos un resumen de todas ellas:

• @babel nos permite trabajar a gusto con JSX y que el compilador de React no se pierda nada de lo que le programamos.

• @wordpress nos permite trabajar con los recursos que WordPress ofrece a los desarrolladores de Gutenberg.

• webpack nos ayuda a hacer una compilación simulada de react para ver los errores que tenemos y luego nos encapsula todo el código para que esté bien ordenado.

• classnames, css-loader, node-sass, postcss-loader, raw-loader, sass-loader, autoprefixer y style-loader ayudan a webpack a entender el código que escribimos para que pueda trabajar con él y así poder compilarlo.

• path, rimraf y ncp ayudan a que los comandos personalizados sean aún más ágiles.

💎 Filosofía

• Ninguna configuración necesaria: Al momento de clonar e instalar las dependencias no tendrás ninguna necesidad de configurar el proyecto.

• Todo facilidades: Podrás crear y borrar los bloques con solos un comando, ahorrándote minutes de desarrollo. Además, podrás exportar todos tus bloques en un único plugin perfectamente optimizado y funcional.

• Máxima optimización: Cada línea de código de los bloques será compilada y minimizada para que WordPress consuma los mínimos recursos con tu plugin.

• No estás solo: Cualquier problema que te surja podrás comunicarlo en el repositorio y te ayudaremos a solucionarlo sin problemas.

👍 ¿Por qué brok-guten-block?

Muy sencillo, porque te hacemos ganar tiempo:

• Comandos de manejo de bloques: Te ahorrarás tiempo creando, borrando y exportando bloques con los comandos que te dejamos listos para usar.

• Librería de componentes de desarrollo: Te ahorrarás tiempo usando nuestra librería de componentes creada específicamente para agilizar la programación de los bloques, basada en las librerías oficiales de WordPress.

• Cero preocupaciones: Te ahorrarás tiempo revisando las actualizaciones de las dependencias, nosotros ya lo haremos por ti.

⚜️ Todos para uno, uno para todos

Este es un proyecto hecho por y para la comunidad, un proyecto de todos. Aunque el equipo de mowomo.com realice el grueso del mantenimiento y de las actualizaciones, cualquier integrante de la comunidad puede hacerle un folk al proyecto y mejorar cualquier apartado del repositorio.

Cada vez que veamos un pull request lo estudiaremos y si aporta alguna mejora al repositorio no tendremos ningún problema en añadirlo y actualizar la lista de contribuidores. Conviértete en un gbg-contributor.