https://github.com/wpengine/block-pattern-explorer

An experimental plugin to preview and insert block patterns in WordPress.
https://github.com/wpengine/block-pattern-explorer

gutenberg wordpress wordpress-plugin

Last synced: 10 days ago
JSON representation

An experimental plugin to preview and insert block patterns in WordPress.

• Host: GitHub
• URL: https://github.com/wpengine/block-pattern-explorer
• Owner: wpengine
• License: gpl-2.0
• Created: 2022-01-05T19:50:10.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-06T16:32:44.000Z (about 1 year ago)
• Last Synced: 2024-04-23T14:03:04.676Z (7 months ago)
• Topics: gutenberg, wordpress, wordpress-plugin
• Language: JavaScript
• Homepage:
• Size: 2.09 MB
• Stars: 19
• Watchers: 53
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Block Pattern Explorer

[![License](https://img.shields.io/badge/license-GPL--2.0%2B-green.svg)](https://github.com/wpengine/block-pattern-explorer/blob/master/LICENSE.txt)

![Block Pattern Explorer](https://user-images.githubusercontent.com/4832319/149385531-404f1d6f-4401-4786-9bfe-50b0be212adc.png)

The Block Pattern Explorer is an experimental WordPress plugin based **heavily** on the work currently being done in [Gutenberg](https://github.com/WordPress/gutenberg).

The purpose of this project is to isolate the pattern explorer into a standalone plugin that WordPress users/developers can interact with immediately, provide feedback on, and begin implementing into their own websites. Ideally, this initiative will also help inform the direction of core development.

Once the pattern explorer is fully integrated into WordPress proper, this project will be sunsetted in favor of the core offering. Below is a list of current pull requests that are related to the Block Pattern Explorer in Gutenberg.

- [#35006](https://github.com/WordPress/gutenberg/pull/35006)

- [#35773](https://github.com/WordPress/gutenberg/pull/35773)

## Requirements

- WordPress 5.8+

- [Gutenberg](https://github.com/WordPress/gutenberg) plugin (Not required if using WordPress 5.9+)

- PHP 7.1+

## Development

1. Set up a local WordPress development environment, we recommend using [Local](https://localwp.com/).

2. Clone / download this repository into the `wp-content/plugins` folder.

3. Navigate to the `wp-content/plugins/block-pattern-explorer` folder in the command line.

4. Run `npm install` to install the plugin's dependencies within a `/node_modules/` folder.

5. Run `composer install` to install the additional WordPress composer tools within a `/vendor/` folder.

6. Run `npm run start` to compile and watch source files for changes while developing.

Refer to `package.json` and `composer.json` for additional commands.