|
1 | 1 | # Block Pattern Explorer |
2 | 2 |
|
3 | | -[](https://github.com/ndiego/block-pattern-explorer/blob/master/LICENSE.txt) |
| 3 | +[](https://github.com/wpengine/block-pattern-explorer/blob/master/LICENSE.txt) |
4 | 4 |
|
5 | | - |
| 5 | + |
6 | 6 |
|
7 | 7 | The Block Pattern Explorer is an experimental WordPress plugin based **heavily** on the work currently being done in [Gutenberg](https://github.com/WordPress/gutenberg). |
8 | 8 |
|
9 | 9 | 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. |
10 | 10 |
|
11 | | -Once the pattern explorer is integrated into WordPress proper, this project will be sunsetted in favor of the core offering. |
| 11 | +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. |
12 | 12 |
|
13 | | -### Requirements |
| 13 | +- [#35006](https://github.com/WordPress/gutenberg/pull/35006) |
| 14 | +- [#35773](https://github.com/WordPress/gutenberg/pull/35773) |
14 | 15 |
|
15 | | -- For best results, it's recommended that you use the Block Pattern Explorer is conjunction with Gutenberg, at least until WordPress 5.9 is released. |
16 | | -- You need to have the Block Editor enabled on your WordPress site. |
| 16 | +## Requirements |
17 | 17 |
|
18 | | -### Follow Core Development |
| 18 | +- WordPress 5.8+ |
| 19 | +- [Gutenberg](https://github.com/WordPress/gutenberg) plugin (Not required if using WordPress 5.9+) |
| 20 | +- PHP 7.1+ |
19 | 21 |
|
20 | | -Below is a list of current pull requests that are related to the Block Pattern Explorer in Gutenberg. Props to [@ntsekouras](https://github.com/ntsekouras) and [@shaunandrews](https://github.com/shaunandrews) who are spearheading much of this work. |
| 22 | +## Development |
21 | 23 |
|
22 | | -- https://github.com/WordPress/gutenberg/pull/35006 |
23 | | -- https://github.com/WordPress/gutenberg/pull/35773 |
| 24 | +1. Set up a local WordPress development environment, we recommend using [Local](https://localwp.com/). |
| 25 | +2. Clone / download this repository into the `wp-content/plugins` folder. |
| 26 | +3. Navigate to the `wp-content/plugins/block-pattern-explorer` folder in the command line. |
| 27 | +4. Run `npm install` to install the plugin's dependencies within a `/node_modules/` folder. |
| 28 | +5. Run `composer install` to install the additional WordPress composer tools within a `/vendor/` folder. |
| 29 | +6. Run `npm run start` to compile and watch source files for changes while developing. |
| 30 | + |
| 31 | +Refer to `package.json` and `composer.json` for additional commands. |
0 commit comments