ॐ

generator-dharma : A WordPress site Yeoman generator for Overhaul Media.

Dharma signifies behaviours that are considered to be in accord with order that makes life and universe possible, and includes duties, rights, laws, conduct, virtues and “right way of living”.

The Dharma generator builds a base WordPress project following best practices and methods for WordPress and front-end development.

How do I get started?

Install generator-dharma globally from npm and initiate in a fresh project directory:

$ npm install -g generator-dharma
$ yo dharma

No, really, how do I get started?

Okay, first you need to be in the right environment. This should only need to be done one time as once the tools are installed they can be used on multiple projects.

On a Mac? Got Terminal open? Here we go:

1. First, install Homebrew.

   $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

   Homebrew is great for managing command-line executables, like git and npm, which we'll install next.

2. Next, install node package manager.

   $ brew install npm

   Node is like Homebrew except (generally) front-end–focused and everything is built with Javascript.

3. Install Yeoman and his friend, Bower.

   $ npm install -g yo bower

   Yeoman uses generators—like this one!—to rapidly generate a project structure. Bower is a package manager like Node and Homebrew, but specifically for front-end components (i.e. jQuery plugins, &c.).

4. Install Gulp. or Grunt. Or both, why not?

   $ npm install -g gulp grunt

   Gulp (and Grunt) is a task runner. Used during development, these tools can automate a lot of the tedious stuff so we don’t need to remember if the CSS was minimised or images were optimised.

5. Now install generator-dharma and run it in a new project folder

   $ npm install -g generator-dharma
   $ yo dharma

   Just follow the on-screen prompts from there!

Credits and collaboration

generator-dharma is maintained by Jeff Nelson at Overhaul Media and is licenced under the MIT licence. We welcome comments, feedback and suggestions. Please feel free to raise an issue or pull request.