Gutenblock

a custom block to blockify the famous Hello Dolly, plugin

⚠ Note: This repository has been archived and is no longer maintained.

This project was implemented to learn and get started building custom WordPress plugins for the Gutenberg editor back in 2023.
It is no longer in active use, and there are no current or future plans to contribute to or develop this repository further.

The code and history remain available for reference. Feel free to browse or fork, but please be aware that:
- Issues and pull requests are disabled
- No support or updates will be provided

Thanks for your interest!

Introduction

Gutenblock is a repository made to experiment with custom blocks targeted for the new WordPress editor, Gutenberg. The custom block was developed locally using Docker Compose. Choosing the Hello-Dolly plugin is a great way for beginners to get started with block development. Follow the git commit history on how Gutenblock was created. Share any comments, feedback, or inquiries. I always love to hear and learn from the community❤

Learn more about developing custom blocks from the official documentation.

Installing / Getting started

This is an overview of the minimal setup needed to get started.

Prerequisites

• Git
• Docker
• Docker Compose
• Docker Desktop
• Node v14.0.0+
• IDE/Code/Text editor (PHPStorm, VScode, Vim, etc)

Follow these tutorials on setting up Docker and Compose on either Mac or Linux. I'd recommend Microsoft's documentation to set up Docker on WSL2 if you're on Windows. Use this guide to install on your host machine Node v14, which is the recommended version in the custom block developer handbook.

Local Setup

The following setup was run on Ubuntu Focal (20.0.4 LTS)

Gutenblock has a single branch, main.
You can clone this repo with the following command.

• Clone the repository

    # cd your/desired/target/dir
    $ git clone https://github.com/apexDev37/Gutenblock.git
    $ cd Gutenblock

This will clone the repository to a target directory on your host machine and navigate into its root directory.

Configuration

Before running WordPress with Docker Compose, configure the required environment variables defined in the ./configuration directory. Example env files are provided to configure the following instances: WordPress, MySQL, and phpMyAdmin.
You can create env files with the following code snippet.

• Create env files

    # ensure you're in the project root
    $ cd configuration/
    $ git clone https://github.com/apexDev37/gutenblock.git
    $ cd Gutenblock