Documentation for Developers
Steps you need to follow
- wp-env
If you have Docker installed, you could use wp-env package to load a WordPress development environment with this plugin automatically activated.
To setup the repository for local dev
To setup the repository for local dev
Fork the GitHub repository
Although you can download a zip file of the plugin at:
https : //github.com/GatherPress/gatherpress
Clone the GitHub repository
Although you can download a zip file of the plugin at:
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:
git clone [email protected]:YourGithubUsername/gatherpress.git
if you have your SSH keys set up. If not, run:
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: npm i -g @wordpress/env
Change directory and run wp-env
In your terminal window, run: 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
In a terminal window, run: npm i -g @wordpress/env
Change directory and run wp-env
In your terminal window, run: cd gatherpress wp-env start
You should then see that a development site has been configured for you on localhost port 2003
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: “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.
Change directory and run wp-env
In your terminal window, run: cd gatherpress wp-env start
You should then see that a development site has been configured for you on localhost port 2003
To shut down your development session
Simply run: wp-env stopFor more info on wp-env package, consult the Block Handbook’s page.