theideabureau / bureau-wordpress-boilerplate Goto Github PK

View Code? Open in Web Editor NEW

6.0 6.0 0.0 6.93 MB

Our homegrown WordPress boilerplate, used on most of the projects here at The Idea Bureau.

Home Page: http://theideabureau.co

License: MIT License

PHP 28.83% CSS 0.13% JavaScript 1.11% SCSS 34.61% Twig 35.32%

lumberjack wordpress

bureau-wordpress-boilerplate's Introduction

The Idea Bureau → WordPress Boilerplate

Version: 2.0.1

Environment	Status
Production	❌
Staging	❌

Template Tasks

Project dependencies

Project guidelines

Git-Flow to be used for git branching
PHP PSR-12 coding standards
.editorconfig rules used to maintain coding styles

Code Quality

PHP

We use PHP CodeSniffer to enforce the PSR12 coding style, any PHP code style issues must be resolved before committing. Buddy.works will fail a deployment if code quality checks don't pass.

Installation and usage

Front-end

Start by installing all npm dependencies:

npm install

Laravel Mix provides various commands to compile front-end assets:

npm run watch          # watch all files and compile
npm run hot            # watch all files, compile with live reload
npm run development    # compile without minify
npm run production     # compile with minify

SVG sprites

SVG files within the /resources/svg directory will be combined into a single SVG sprite, and can be referenced using the following snippet, where a filename of icon-twitter.svg is referenced as:

<svg><use xlink:href="#icon-twitter"></use></svg>

SVGs used like this can be interacted with JavaScript and styled with CSS.

All SVGs must be optimised before being added to the codebase, tools such as svgomg can be useful for this.

Back-end

Composer is used for back-end libraries, use the following command to install dependencies.

composer install

Lock files

Both npm and composer lock files are to be committed.

bureau-wordpress-boilerplate's People

Contributors

Stargazers

Watchers

bureau-wordpress-boilerplate's Issues

Reset meta theme colour to a generic value

Setup PHP CodeSniffer

Remove adaptive images

Adaptive images no longer provides any value to this project, it should be removed and later srcset should be added.

Add improved empty search results page

When searching with no query the template outputs all posts it can find.

It would be helpful to display a page that allows you to initiate a search, offers instruction and perhaps some popular searches etc.

Improve messaging of ACF requirement

It's not clear that ACF installed, an exception should be thrown

Create simple placeholder code for custom login image

Excerpt Function

add_filter('wp_trim_excerpt', function($excerpt) {
    global $excerpt_length;
    return trim(substr(str_replace( '[&hellip;]', '', $excerpt ), 0, $excerpt_length)) . ' ...';
});

Investigate on-the-fly image croping

I have discovered the WP_Image_Editor class within WordPress and think that it may be able to improve our image workflow.

At the moment we register the image size within the functions file and use a thumbnail regeneration plugin to re-create any legacy images.

This means we could be creating n different image sizes for instances that an image may never be viewed in.

It also means when using migrate db pro to copy the database and media that we're downloading a lot of files, this can take some time for larger sites.

This should be investigated and, if appropriate, incorporated within the WordPress boilerplate.

block.json definition file
render.php render file
a .twig for markup
a .scss for styles
a .js for behaviour

Rather than these being spread across the theme, consider bringing these files together for ease of development.