A variation on Marc Jaquith's excellent WordPress Skeleton. Helps getting a WordPress project bootstrapped quickly.
Composer is used to install WordPress.
$ composer install
NPM installs Grunt & friends
$ npm install
// While developing.
$ grunt watch
// Prepare for distribution.
$ grunt dist
WordPress is installed in a subfolder and the theme, plugins, uploads and other data are kept in the content folder in the root directory.
+-- content/
| +-- mu-plugins/ (Contains an example plugin and theme)
| +-- plugins/
| +-- themes/ (Empty, an example theme is included in the example mu-plugin)
| +-- uploads/ (Content is not tracked in the repository)
| +-- ...
+-- wp/ (WordPress package)
+-- wp-config-local.php (Configuration and MySQL settings for the local development site)
+-- wp-config-production.php (MySQL server settings for the production site)
+-- wp-config.php (General configuration settings)
+-- ...
The included example plugin tries to adhere to the WordPress Coding Standards. Compliance can be checked by using the PHP_CodeSniffer script and installing the WordPress Coding Standards Ruleset.
A phpcs.ruleset.xml file is included in the project root folder.
Run phpcs --standard=phpcs.ruleset.xml --report-file=phpcs.log in the project root folder to check WPCS complaince on all of the plugin and theme's PHP and CSS files. For reference, a phpcs.log error log file will be written to the root folder.
A grunt jshint Grunt task is available to check against the WordPress JavaScript coding standards.
WordPress allows you to specify additional theme folders. This feature is used by the example plugin to include the theme inside the plugin folder. Usually my WordPress project code mainly consists of a theme and a site-specific plugin. I find including the theme in the plugin keeps the project code nicely bundled together.
To get up and running quickly, I like to deploy stuff using the dandelion gem. An example dandelion.yml file is included.