pipdig / Gutenberg-Boilerplate

🔰 WordPress Gutenberg Boilerplate! — Easy to understand and extensively inline documented starter WordPress plugin for the new Gutenberg editor. Think of it like a create-react-app for WP Gutenberg. ——— I now recommend 🔥 ⚛‏ 📦 `create-guten-block` → https://AhmdA.ws/CreateGutenBlock

IMPORTANT UPDATE:

🔰 Instead of this boilerplate, I now recommend using 🔥 ⚛‏ 📦 create-guten-block →

---

Gutenberg Boilerplate An easy to understand and heavily documented️ WordPress Gutenberg Boilerplate!
A FOSS (Free & Open Source Software) project. Maintained by @AhmadAwais.

⚡️ WordPress Gutenberg Boilerplate

Build your first Gutenberg Editor block! A boilerplate to build WP Gutenberg blocks and stuff! ✊

⚡️ Getting Started

1. ✅ Install & activate the Gutenberg WordPress plugin
2. ✅ Then download and install/activate this Gutenberg Boilerplate plugin ← Just click this link to download.
3. 🙊 All blocks added by this boilerplate are prefixed with GB as in Gutenberg-Boilerplate. Take a look at the GIFs below to see how to try 'em out.
4. 🎯 To try the ESNext block, i.e. 02-basic-esnext go to it's directory i.e. gutenberg-boilerpalte/block/02-basic-esnext and run npm install. Make sure you have Node and npm installed. Then in the 02-basic-esnext directory run npm run dev for development or npm run build to build the production code.
5. 💯 Now read the source code to learn how to build blocks. It's heavily documented.

RECOMMENDED READING: Read the blog post I wrote → Gutenberg Boilerplate For Third-Party Custom Blocks.

⚡️ What Can You Learn?

This is a todo list for this boilerplate which also states the progress of what you can learn from it.

• BLOG POST: Gutenberg Boilerplate For Third-Party Custom Blocks.
• Build a Custom Gutenberg Block — with custom CSS for editor and front end.
• Build a Custom Gutenberg Block — with ES6 or ESNext and a Webpack build process.
• Build a Custom Gutenberg Block — with editable content.
• Build a Custom Gutenberg Block — to click Tweet the contents of that block.
• Build a Custom Gutenberg Block — with editable content and custom toolbars.
• Build a Custom Gutenberg Block — with a card layout editable + non-ediatable content (text + media).
• Maybe build a video series on Gutenberg development!

🍩 GIF Me Some Proof!

Sure thing! Here are a few examples of how you can use this WordPress plugin. When you install it after installing the Gutenberg plugin, this plugin gives you following four additional blocks.

📦 Block #1

Build a Custom Gutenberg Block — with custom CSS for editor and front end.

📦 Block #2

Build a Custom Gutenberg Block — with ES6 or ESNext and a Webpack build process.

🎯 To try the ESNext block, i.e. 02-basic-esnext go to it's directory i.e. gutenberg-boilerpalte/block/02-basic-esnext and run npm install. Make sure you have Node and npm installed. Then in the 02-basic-esnext directory run npm run dev for development or npm run build to build the production code.

📦 Block #3

Build a Custom Gutenberg Block — with editable content.

📦 Block #4

Build a Custom Gutenberg Block — to click Tweet the contents of that block.

⚡️ License & Attribution

Code is licensed under GPL v3.0. The content and documentation is copyrighted to the WordPress Gutenberg team and WGA - AhmadAwais.com (especially the content in the blog post). I am still making up my mind with how Gutenberg will fit in the WordPress core. There are so many things which are both good and bad about it. So, instead of ranting about it, I wanted to do something more productive. I went ahead, studied the source code and received a lot of help from Gutenberg project and its contributors (Matias Ventura, James Nylen, Riad Benguella, Andrew Duthie, Joen, etc.) to finally build this. I started with three different repos which now co-exist as the Gutenberg examples and added more examples and documentation, using the Gutenberg code as a reference. Thanks to the Gutenberg team for a lot of help along the way.

I also wrote about it Gutenberg Boilerplate For Third-Party Custom Blocks.

---

🙌 Hello, from the WPCouple! I (Ahmad Awais) am a Full Stack Web Developer and a regular core contributor at WordPress. My wife (Maedah Batool) is a WordPress Journalist/Dev/Core Contributor. If you'd like to get insights into professional full stack development, DevOps, WordPress community news, growing up a family, building and bootstrapping a business then subscribe to our premium newsletter called ↣ The WordPress Takeaway!

---

🎩 Support Ahmad's Open Source Projects!

If you'd like me to keep producing professional free and open source software (FOSS). Consider paying for an hour of my time. I'll spend two hours on open source for each contribution.

---

🙌 WPCOUPLE PARTNERS:

This open source project is maintained by the help of awesome businesses listed below. What? Read more about it →