You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-8Lines changed: 31 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -21,41 +21,64 @@ This repo is by no means perfect and should not been seen as an "official" way t
21
21
22
22
## Getting Started
23
23
24
-
If you'd like to play around with this custom block editor then:
24
+
If you'd like to play around with this custom block editor then you have 2 options:
25
25
26
-
Clone this repo into the `plugins` directory of a WordPress installation.
26
+
1. Use the WordPress Docker environment bundled with this Repo (provided via [`@wordpress/env`](https://developer.wordpress.org/block-editor/packages/packages-env/).
27
+
2. Clone this repo directly into the `plugins` directory of a WordPress installation.
27
28
28
-
```bash
29
-
// Change into your local WP install's Plugin directory.
30
-
cd {{mylocalwp}}/wp-content/plugins/
29
+
Either way you'll want to take the following steps:
*Important*: check you have [the necessary prerequisites to run `wp-env`](https://developer.wordpress.org/block-editor/packages/packages-env/#prerequisites).
51
+
52
+
### Start the WordPress Environment (optional)
53
+
54
+
Start the environment (if using):
55
+
56
+
```bash
57
+
npm run wp-env start
58
+
```
59
+
60
+
You should now be able to login to WordPress at [`localhost:7575/wp-admin`](http://localhost:7575/wp-admin):
61
+
62
+
*`username`: `admin`
63
+
*`password`: `password`
64
+
65
+
### Build the Plugin
66
+
67
+
Open a new terminal in the same [`standalone-block-editor/`] directory, then build the Plugin:
47
68
48
69
```bash
49
70
npm run build
50
71
```
51
72
52
-
...or alternatively to watch build automatically on file change:
73
+
...or if you'd prefer to watch and build _automatically_ on file change run:
53
74
54
75
```bash
55
76
npm run start
56
77
```
57
78
58
-
**Activate the Plugin** from within WP Admin.
79
+
### Activate the Plugin
80
+
81
+
Open the Plugins page within WPAdmin [`localhost:7575/wp-admin/plugins.php`](http://localhost:7575/wp-admin/plugins.php) and activate the `Standalone Block Editor Demo` Plugin.
0 commit comments