README

Boilerplate

Boilerplate for new libraries, WordPress plugins or themes.

Requirements

PHP >= 7.0

Note that this is the requirement for using this boilerplate, not the requirement for the generated packages. Those may require higher versions or also support lower versions, depending on your preferences.

Usage

Simply create a new project via Composer, using this repository as a foundation:

composer create-project felixarntz/boilerplate <package-folder>

You will be asked questions about the type of the project and several parameters. Provide responses and follow the instructions to get your project set up within a minute.

You will be asked for the following project properties:

Vendor name
Package name
Package description
Package keywords (comma-separated list)
Package VCS URL
Package URL
Author name
Author email
Author URL
Package type ("library" or "plugin")
Minimum PHP version (anything greater than or equal to 5.2)
Minimum WordPress version (anything greater than or equal to 3.7)
Code standard ("psr2" or "wordpress")
Setup code standards?
Setup quality assurance?
Setup unit tests?
Setup integration tests?
Integrate with CodeClimate?
Integrate with Travis-CI?
Prepare for Packagist?
Prepare for wordpress.org?
WordPress.org contributors (comma-separated list)

Some of these questions will only be asked based on the responses you gave to prior questions. For example, WordPress-related details are only requested if you provided a package type of "plugin" or "theme".

Disclaimer

PHP 5.2 support at this time is available, but limited. Due to WordPress core dropping support for that version anyway, it is unlikely that better support will be added.

Credit

Major credit goes to @schlessera and his brightnucleus/boilerplate project, which this is a heavily modified version of.

felixarntz / boilerplate

Maintainers

Details