Keep a DRY README.md for wordpress.org & Github #653
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| ## Developer Documentation | ||
|
|
||
| ### .wp-env | ||
|
|
||
| If you have Docker installed, you could use the `wp-env` package to load a WordPress development environment with this plugin automatically activated. | ||
|
|
||
| ### Local Development | ||
|
|
||
| #### Fork this repository | ||
|
|
||
| Although you can download a zip file of the plugin at: | ||
|
|
||
| ``` | ||
| https://github.com/GatherPress/gatherpress | ||
| ``` | ||
|
|
||
| If you want to help out with development, we suggest forking the code to your own Github repository and creating a branch from there. | ||
|
|
||
| #### Clone this repository | ||
|
|
||
| Once you've forked the repo, you should now have a mirrored copy of GatherPress, but on your profile's URL, or something like this: | ||
|
|
||
| ``` | ||
| https://github.com/YourGithubUsername/gatherpress | ||
| ``` | ||
|
|
||
| where `YourGithubUsername` corresponds to your login name for Github. | ||
|
|
||
| To clone a local copy, open a terminal window and run the following command: | ||
|
|
||
| ```sh | ||
| git clone git@github.com:YourGithubUsername/gatherpress.git | ||
| ``` | ||
|
|
||
| if you have your SSH keys set up. If not, run: | ||
|
|
||
| ```sh | ||
| git clone https://github.com/YourGithubUsername/gatherpress.git | ||
| ``` | ||
|
|
||
| ##### Note about customizing the URL | ||
|
|
||
| Once you have forked the GatherPress repo, you can also change the folder name of your version of the repository by going into your settings of your repo on Github's website. | ||
|
|
||
| ``` | ||
| https://github.com/pbrocks/gatherpress | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ### Install wp-env globally | ||
|
|
||
| In a terminal window, run: | ||
|
|
||
| ```sh | ||
| npm i -g @wordpress/env | ||
| ``` | ||
|
|
||
| #### Change directory and run wp-env | ||
|
|
||
| In your terminal window, run: | ||
|
|
||
| ```sh | ||
| cd gatherpress | ||
| wp-env start | ||
| ``` | ||
|
|
||
| You should then see that a development site has been configured for you on localhost port 2003 | ||
|
|
||
|  | ||
|
|
||
| #### Log in to Site / Log into Site | ||
|
|
||
|  | ||
|
|
||
| #### Development Site Plugins/Themes | ||
|
|
||
| To further customize the development site using your favorite or most familiar development plugins or themes, you are able to add whatever you like because of this code added to the `.wp-env.json` file: | ||
|
|
||
| ```json | ||
| "mappings": { | ||
| "wp-content/plugins": "./wp-core/plugins", | ||
| "wp-content/themes": "./wp-core/themes" | ||
| }, | ||
| ``` | ||
|
|
||
| In fact, after the initial setup, you may notice that in your code editor, there is now a `wp-core` folder containing the default plugins and themes, but it is grayed out, so the contents of this folder will not be committed to the GatherPress repository. | ||
|
|
||
|  | ||
|
|
||
| #### To shut down your development session | ||
|
|
||
| Simply run: | ||
|
|
||
| ```sh | ||
| wp-env stop | ||
| ``` | ||
|
|
||
| For more info on wp-env package, consult the [Block Handbook's page](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/). |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to mention as it is also in WordPress list.
