Skip to content

WoodChippr: WordPress development project scaffold and toolchain

Notifications You must be signed in to change notification settings

Gaffen/WoodChippr

Repository files navigation

#WoodChippr

A highly opinionated workflow and development framework for wordpress

WoodChippr uses Timber for bringing better separation of concerns in relation to application structure, and the Bones starter theme to provide some niceties for bringing wordpress under control.

This theme comes with a large array of opinionated defaults. This includes the following plugins:

By default WoodChippr includes some tracking code in the header. If you don't change this it will remind you with a big ass h1 before your site code starts. To change this either edit views/partials/tracking.twig, or change $context['analyticscode'] in functions.php

##Who should use this project?

Anyone who has experience creating Wordpress themes, and tends to use Wordpress more as a web framework than a blogging engine. This project aims to extend the famous 5 minute install process for theme developers, by giving them a complete development environment complete with package management and frontend development tooling out of the box.

PLEASE NOTE: As this framework is designed for theme developers, the actual theme itself is the bare essentials needed to make a theme appear in the Wordpress appearance section, with a few extras thrown in to provide helper functionality.

##Installation:

  • Place files on server
  • 'composer install'
  • Fill out and rename local-config-sample.php to local-config.php and wp-config sample. local-config is only needed for local development.
  • Fill in database access details
  • WP_CONTENT_URL can also be overwritten in this file.

##Dev Env

  • Install Node
  • npm install
  • run gulp
  • 'composer install' to add new php modules

##Requiring plugins

Depending on the plugin here are two recommended approaches to requiring plugins for your theme:

  1. Include the plugins in the composer.json file, this will install the mu-plugins folder.
  2. Run composer create-project tgmpa/tgm-plugin-activation --no-dev in your theme directory, it is recommended to do this in the functions directory. this will set up a TGMPA instance in your theme, check example.php for instructions for stipulated recommended or required plugins for your theme. You should use this method if the plugin does more than provide utility functions for your theme and required the plugin activation hook to fire.