README.md

This repo requires node.js, npm and gulp. Install node using nvm. Ensure you are running at least Node 15.2.0 & npm 7.0.8. Install gulp globally.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
nvm install node # "node" is an alias for the latest version
npm install gulp-cli -g

WordPress setup

Spin up a new WordPress site using Local by Flywheel

• Site name: yoursitename.local
• PHP Version: 7.4+
• Web Server: nginx
• Database: MySQL 8.0+

Set WordPress environment using wp_get_environment_type(). This function provides a standardized way for developers to differentiate how they handle specific functionality between production and development sites.

Add the following code to wp-config.php

/** Set Wordpress environment to local */
define( 'WP_ENVIRONMENT_TYPE', 'local' );
/** Enable Jetpack Offline Mode */
define( 'JETPACK_DEV_DEBUG', true );
/** Enable debug mode */
define( 'WP_DEBUG', true );

Build setup

# clone this repository into the local theme directory
cd path/to/themes/directory
git clone https://github.com/katie-co/wordpress-boilerplate
npm install

# update proxy server in `gulpfile.js` (line 26) to match your local domain

# launch site and watch for changes
gulp

# view all commands
gulp --tasks

GitHub Actions will run gulp build task to generate compressed style.css file at each pull request

Note All commands run from local node_modules directories so there should be no need to install anything globally.