fivefifteen/primer

A WordPress theme boilerplate. The perfect starting point for your custom WordPress theme.

0.0.4 2025-02-07 19:39 UTC

Requires

• composer/installers: ^2.3

Requires (Dev)

• fivefifteen/fetcher: 0.0.5
• fivefifteen/piler: 0.0.3

GPL-2.0

• Five Fifteen
• Kodie Grantham

• theme
• template
• wordpress
• boilerplate
• example
• starter

README

Primer

A WordPress theme boilerplate. The perfect starting point for your custom WordPress theme.

A Five Fifteen Project

Table of Contents

• Features
• Requirements
• Usage
• Commands
• Related Projects
• License Information

Features

• Front-end dependency management using GitHub & npm as repositories via Fetcher
• JavaScript & CSS/SCSS compilation/minification via Piler
• Boilerplate code for configuring custom post types, taxonomies, and user roles
• Some sensible plugin hooks:
  • Gravity Forms: Disable the built-in theme (so we can create a custom one)
  • Updraft Plus: Prevent backups being created for non-production environments
  • Yoast SEO: Custom breadcrumb separator when using the yoast_breadcrumb function

Requirements

• PHP 8.1 or above
• Composer

Usage

Run the following command (replacing "my-new-theme" with your theme's slug):

composer create-project fivefifteen/primer my-new-theme

Commands

Command	Description
composer build	Compiles/minifies JavaScript & CSS/SCSS files via Piler
composer fetcher	Displays a list of available Fetcher commands
composer fetcher install [...dependencies]	Installs dependencies from GitHub or npm
composer setup	Installs frontend dependencies and builds them
composer watch	Watches for changes to JavaScript & CSS/SCSS files and recompiles/minifies as needed

Related Projects

• Basis - A WordPress boilerplate. Get a local dockerized WordPress project up and running complete with secrets encryption, dependency management/compilation, and more by running a single command.
• WordUp - A WordPress Deployer Recipe.

License Information

GPL-2.0 (See the license.md file for more info)