https://github.com/stormwarning/generator-dharma
A WordPress site Yeoman generator for Overhaul Media.
https://github.com/stormwarning/generator-dharma
Last synced: 5 months ago
JSON representation
A WordPress site Yeoman generator for Overhaul Media.
- Host: GitHub
- URL: https://github.com/stormwarning/generator-dharma
- Owner: stormwarning
- Created: 2014-03-20T19:26:21.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2015-09-09T05:26:45.000Z (almost 11 years ago)
- Last Synced: 2025-02-13T20:38:33.672Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 632 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ॐ
`generator-dharma` : A [WordPress](http://wordpress.org/) site [Yeoman](http://yeoman.io/) generator for [Overhaul Media](http://overhaulmedia.com/).
> _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.
[](https://github.com/overhaul/generator-dharma/releases)
[](https://www.npmjs.com/package/generator-dharma)
[](https://codeclimate.com/github/overhaul/generator-dharma)
[](https://travis-ci.org/overhaul/generator-dharma)
[](https://github.com/overhaul/generator-dharma/issues)
## How do I get started?
Install `generator-dharma` globally from npm and initiate in a fresh project directory:
```shell
$ 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](http://brew.sh/).
```shell
$ 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](https://npmjs.org/).
```shell
$ brew install npm
```
Node is like Homebrew except (generally) front-end–focused and everything is built with Javascript.
3. Install [Yeoman](http://yeoman.io/) and his friend, [Bower](http://bower.io/).
```shell
$ 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](http://gulpjs.com/). or Grunt. Or both, why not?
```shell
$ 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
```shell
$ 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](https://github.com/stormwarning) at [Overhaul Media](http://overhaulmedia.com/) and is licenced under the MIT licence. We welcome comments, feedback and suggestions. Please feel free to raise an issue or pull request.