https://github.com/barryceelen/wp-eelknots
A variation on Marc Jaquith's excellent WordPress Skeleton.
https://github.com/barryceelen/wp-eelknots
wordpress wordpress-skeleton
Last synced: 2 months ago
JSON representation
A variation on Marc Jaquith's excellent WordPress Skeleton.
- Host: GitHub
- URL: https://github.com/barryceelen/wp-eelknots
- Owner: barryceelen
- Created: 2016-05-30T15:10:18.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-11-19T10:36:15.000Z (over 4 years ago)
- Last Synced: 2025-07-16T01:31:55.293Z (12 months ago)
- Topics: wordpress, wordpress-skeleton
- Language: PHP
- Homepage:
- Size: 153 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WordPress Eelknots
A variation on Marc Jaquith's excellent [WordPress Skeleton](https://github.com/markjaquith/WordPress-Skeleton). Helps getting a WordPress project bootstrapped quickly.
## Installation
Composer is used to install WordPress.
```
$ composer install
```
NPM installs Grunt & friends
```
$ npm install
```
### Build theme assets
```
// While developing.
$ grunt watch
// Prepare for distribution.
$ grunt dist
```
## Folder structure
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)
+-- ...
```
## WordPress Coding Standards
The included example plugin tries to adhere to the [WordPress Coding Standards](https://codex.wordpress.org/WordPress_Coding_Standards). Compliance can be checked by using the [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) script and installing the WordPress Coding Standards [Ruleset](https://codex.wordpress.org/WordPress_Coding_Standards).
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.
## Theme in a plugin?
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.
## Deployment
To get up and running quickly, I like to deploy stuff using the [dandelion](https://github.com/scttnlsn/dandelion) gem. An example dandelion.yml file is included.