This WordPress plugin adds a graphical shortcode creator for the List Category Posts plugin. The creator is available in WordPress editor by clicking the 'LCP' button in the editor's toolbar.
This repository contains a development version of the plugin, with build tools and testing environment configurations. If you just download this repository and add it to your WordPress installation it won't work. Production releases are available on the plugin's page in WordPress.org plugin directory.
Please use the WordPress support forum for user support and any questions about how to use the plugin. Github issues should only be used for bug reports, feature requests and other code-related topics.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
The actual plugin code is located in the gui-for-lcp directory, everything above it is config, docs and build tools.
The testing environment is a Vagrant box powered by VCCW.
The build is run by npm, for all its tasks to work you need to have Node.js installed:
The virtual machine used for testing needs:
Fork the repo, clone it locally and cd into its root directory.
npm install
vagrant up
The above command will:
- Create and provision a new virtual machine (Ubuntu + LAMP stack + WordPress)
- Create a
wordpressdirectory and mount it on the virtual box's WordPress installation. - Mount the
gui-for-lcpdirectory on the following virtual box directories:/vagrantwp-content/plugins/gui-for-lcpin the WordPress directory
Any changes in the mounted directories are reflected in the Vagrant box.
If the Vagrant box is not active run vagrant up. Then in your browser navigate to http://192.168.33.10/
WP admin login:
- Username:
admin - Password:
admin
To avoid running build scripts manually every time you change SCSS or JS files, a watch task has been set up.
npm run watch
This will automatically compile CSS files and bundle JS whenever you change the source. Files generates by this task are not fit for production, however.
npm run build
Currently there is no testing suite, but PHP Code Sniffer has been set up to enforce WordPress Coding Standards.
Ssh into the box by running
vagrant ssh
Then cd into /vagrant directory and run
phpcs -p
Please read CONTRIBUTING.md for details on the process for submitting pull requests.
I use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the GPL-3.0 License - see the LICENSE.txt file for details