10up/generator-wp-make

Name: generator-wp-make

Owner: 10up

Description: A Yeoman generator for making WordPress things

Created: 2014-05-23 04:56:20.0

Updated: 2018-01-03 19:49:48.0

Pushed: 2017-01-31 20:10:36.0

Homepage: null

Size: 452

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

WP-Make

Build Status

RNING

-Make is currently undergoing a rewrite, heading towards version 1. The
able version of WP Make is available as the 'master' branch, but the default
anch for this repo is 'develop'. This contains the work on the v1 rewrite.
ease note that these two branches are NOT COMPATIBLE with each other.

 you do switch between the develop and master branches, you will need to
lete your node_modules folder and then run npm install again each time you
itch. Otherwise things will not work.

 you would like to use the stable version, we urge you to use NPM to
stall it. Please make sure any repo versions you may have installed are
linked FIRST. After that you can `npm install -g generator-wp-make`. When
e 1.0 release is ready, yeoman will try to let you know and help facilitate
e update.

 you would like to use the repo version of WP Make, by all means! First
ke sure you don't have a version from NPM on your system. Run
pm uninstall -g generator-wp-make` to be extra sure. Then clone this
pository to your local machine. Open your command prompt to the folder
ere you cloned it. If you would like to run the stable version first
eck out master with `git checkout master origin/master`. Then run
pm install` followed by `npm link`. Don't forget if you want to switch
tween the master and develop branch you need to DELETE your node modules.

 -rf node_modules/
t checkout develop
m install

OR----

 -rf node_modules
t checkout master
m install

 are really looking forward to the new version. In the meantime, please
cuse our mess and thanks for generating with us!

WP-Make is a Yeoman generator for quickly creating new WordPress projects based on some established template designs currently used by 10up.

Briefly, WP-Make can be used to create a new theme, child theme, plugin, or library project - complete with unit tests - in seconds!

Getting Started

If you need it, install Yeoman through npm:

m install -g yo

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

t clone git@github.com:10up/generator-wp-make.git && cd generator-wp-make
m link

Finally, in the desired project directory, initiate the generator:

 wp-make
Project Types

WP-Make ships with four default project types, each invoked with a subgenerator.

For each project type you get:

Plugin

This subgenerator scaffolds out a standard WordPress plugin.

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

Theme

This subgenerator scaffolds out a standard WordPress theme.

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

Child Theme

This subgenerator scaffolds out a standard WordPress child theme.

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

Library

This subgenerator scaffolds out a WordPress library. Libraries are a bit different from plugins in that they're meant to be included via Composer and embedded directly into a theme or a plugin.

Tests

To run tests, execute the below command.

m test
License

MIT


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.