Skip to content
WoodChippr: WordPress development project scaffold and toolchain
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dev
gulp
tasks
web
.eslintrc
.gitignore
.modernizrrc.json
README.md
composer.json
config.json
gulpfile.js
package-lock.json
package.json
sample.env
wp-cli.yml

README.md

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
  • npm install
  • composer install
  • npm run build to minify assets
  • Fill out and rename sample.env to .env and wp-config sample.

Dev Env

  • Install Node
  • npm install
  • npm run setup (if you want to install ACF)
  • npm start
  • '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 requires the plugin activation hook to fire.

Compiler Features

At the moment, you can optionally activate both es6 features like import statements and arrow functions but setting usebabel to true in config.json, and you can also integrate modernizr by setting usemodernizr to true in the same file. Modernizr can be configured using .modernizrrc.json

At the moment extended babel configuration has to be modified in /gulp/babelConfig.json, though I am looking to improve this configuration setup to be more centralised in the near future.

Project Structure and Bundles

At the moment project structure is recorded in config.json. Out of the box it shouldn't need modification. Unlike the .env file, the config.json file contains variables that should be expected to be constant between build environments.

Feedback

This is all a personal project at the moment that I use to help smooth my personal frontend development workflow. If you find any issues or have a feature request please do create an issue and I will do my best to attend to your request. It would be nice to see other people finding this useful, and it's also to my benefit to make this setup as flexible and useful as possible.

You can’t perform that action at this time.