Start

WordPress starter project for custom theme development with Composer, Glide, Vite, Tailwind CSS, Prettier, Deployer, Gutenberg, Advanced Custom Fields and other tools I like.

It contains a few useful WordPress plugins, development tools and a custom starter theme to get a head start with custom theme development. The theme contains a few simple templates, styles and scripts and some PHP classes with sensible defaults that can be easily customized.

Features

This starter project uses the folowing PHP dependencies and JavaScript packages by default. Of course, this can be customized to your liking or the project specific needs:

Development tools

• Composer - PHP dependency manager
• Bedrock autoloader - Autoloader for WordPress plugins
• Env and PHP dotenv - Loads environment variables from .env
• Glide - Image resizing and manipulation
• NPM - Frontend package manager
• Vite - Frontend build tool and local development server
• Tailwind CSS - Utility-first CSS framework
• Prettier - Code formatting
• Prettier PHP - PHP code formatting
• Deployer - PHP deployment tool
• GitHub actions - Automatic deployment

WordPress and plugins

• WordPress - Content Management System
• Gutenberg - WordPress block editor
• Advanced Custom Fields Pro - Custom fields and meta boxes (requires license)
• Rank Math - SEO stuff
• Limit login attempts - Brute force protection
• Proxy cache purge - Purges (Varnish) cache when content is updated
• WP Mail SMTP - Email delivery
• WP Languages - WordPress language packs via Composer

Requirements

Ensure you have the following installed on your system:

• PHP (version 8.1 or higher)
• Composer
• Node.js (version 23 or higher)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/sboerrigter/start.git your-project
   cd your-project

2. Copy .env.example to .env and configure environment-specific variables like WP_ENV, WP_HOME, database credentials and debug settings.

   cp .env.example .env

3. Copy auth.json.example to auth.json and enter you Advanced Custom Fields Pro lisence key in the "username" field and your website's domain in the "password" field.

   cp auth.json.example auth.json

Usage

• Run npm start to install Composer and NPM dependencies and run vite development server:

  npm start

• Build for production:

  npm run build

• Format code with Prettier:

  npm run format

License

This project is licensed under the MIT License.