Skip to content
This repository has been archived by the owner. It is now read-only.

A WordPress plugin generator forked from UF Health's generator-wp project with a focus on projects outside of their requirements.

develop
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

README.md

WordPress Project Generator

Generator-wp is a Yeoman generator for generating a base WordPress plugin (with themes to come) or a test environment for WordPress itself. It is forked from generator-wp at UF Health which is based, in part, on generator-wp-make by 10up.

Installation

If you need it, install Yeoman through npm:

$ npm install -g yo

To install generator-wp clone this repository, enter the directory, and link it to npm:

$ git clone git@github.com:ChrisWiegman/generator-wp.git && cd generator-wp
$ npm install
$ npm link

Finally, in the desired project directory (where your plugin or theme will go), initiate the generator:

$ yo wp

Usage

generator-wp currently ships with te default project type, it is invoked with a subgenerator.

For each project type you get:

  • Composer to manage server-side dependencies
  • NPM to manage development dependencies (like Grunt)
  • Grunt to streamline JS and CSS assets
  • phpunit for PHP unit testing
  • A fully-fleshed out, name-spaced setup for WordPress plugin development
  • A Docker configuration, compatible with Primary Docker, to get you actually working on code quickly.

Plugin

This subgenerator scaffolds out a standard WordPress plugin.

The project even includes some basic unit test examples to help get you started!

$ cd [my-plugin-dir]
$ yo wp:plugin

For information on developing and using a generated plugin see the README.md file within after generating.

Core

This subgenerator sets up a quick WordPress environment for testing or other use.

$ cd [the directory where you want to install WordPress]
$ yo wp:core

After installation is complete bring up the local environment in Docker with the Develop script and run ./Docker/bin/setup. WordPress will then be accessible at http://wordpress.test

More project types coming soon

Changelog

1.0

  • Initial release after form from UF Health

About

A WordPress plugin generator forked from UF Health's generator-wp project with a focus on projects outside of their requirements.

Resources

Packages

No packages published
You can’t perform that action at this time.