README

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.

A Five Fifteen Project

Table of Contents

• Features
• Requirements
• Usage
• Configuration
• Development
• Related Projects
• License Information

Features

• Dockerized development environment via Lando & Docker
• Secrets encryption via SOPS
• Intergrated deployment solution via WordUp & Deployer
• WordPress terminal control via WP-CLI
• WordPress core & plugins management using Packagist & WordPress Packagist as repositories via Composer
  • (Five Fifteen Plugins & Advanced Custom Fields repositories are optionally pre-configured as well)
• Theme boilerplate via Primer
  • Front-end dependency management using GitHub & npm as repositories via Fetcher
  • JavaScript & CSS/SCSS compilation/minification via Piler
  • and more...
• All of the above in a single command 👌

Requirements

• PHP 8.1 or above
• Composer
• Lando

Usage

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

composer create-project fivefifteen/basis my-new-website

The setup script will ask you a few questions (feel free to mash enter and leave everything with default values) and when it's finished the URL to the local version of your new website will be displayed.

Visiting that URL will show you the WordPress setup screen where you can create your admin user account and then log in to the WordPress dashboard.

See your site's newly generated readme.md on what to do from there.

Configuration

The default values for any of the questions that are asked by the setup script can be configured by setting an environment variable with the BASIS_ prefix:

export BASIS_SOPS_AGE_PUBLIC_KEY="age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p"

Development

To create a project for testing using the latest development versions of both Basis and Primer, use the following command:

export BASIS_PRIMER_VERSION=dev-development; composer create-project fivefifteen/basis my-new-website dev-development

Related Projects

• Primer - A WordPress theme boilerplate. The perfect starting point for your custom WordPress theme.
• WordUp - A WordPress Deployer Recipe.

License Information

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