https://github.com/jjones646/generator-wpplug

A Yeoman generator based on the famous Wordpress-Plugin-Boilerplate found on GitHub
https://github.com/jjones646/generator-wpplug

Last synced: about 1 month ago
JSON representation

A Yeoman generator based on the famous Wordpress-Plugin-Boilerplate found on GitHub

• Host: GitHub
• URL: https://github.com/jjones646/generator-wpplug
• Owner: jjones646
• License: mit
• Created: 2016-03-24T01:53:08.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-03-24T13:13:36.000Z (over 8 years ago)
• Last Synced: 2024-10-09T13:15:41.146Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/generator-wpplug
• Size: 30.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-wpplug

A [Yeoman](http://yeoman.io) generator based on the famous [Wordpress-Plugin-Boilerplate](https://github.com/DevinVinson/WordPress-Plugin-Boilerplate) for quickly starting a new [wordpress plugin](https://wordpress.org/plugins).

## Getting Started

### Prerequisites

- [npm](https://npmjs.org) (javascript package manager)

- [Yeoman](http://yeoman.io) (app scaffold generator framework)

If you're using Ubuntu or a similar Debian based Linux distro, these are pretty easy to install as shown below.

```

# install npm

sudo apt-get install npm

# install yeoman for npm to use

sudo npm install -g yo

```

### Installing

To install this generator for use with the `yo` command, use the following command:

```

sudo npm install -g generator-wpplug

```

### How to Use

Open a terminal and cd to the directory you'd like your soon-to-be plugin to be created in. This is usually the wordpress plugin directory, but you could also do everything on your own computer and move it to wordpress server later.

```

# cd into the wordpress plugin directory

cd wp-content/plugins

```

Now use the `yo` command to create the template for your new plugin.

```

# Run the generator

yo wpplug

```

## License

[MIT License](./LICENSE)