• This repository has been archived on 18/May/2022
  • Stars
    star
    1,080
  • Rank 42,846 (Top 0.9 %)
  • Language
    JavaScript
  • License
    Other
  • Created almost 12 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A Yeoman generator for WordPress

image

YeoPress

The officially un-official Yeoman Generator for WordPress. I magically take you from scratching your head wondering where to start, all the way to running the famous 5-minute install. I have configuration options that will WOW you. If you use Git, I can git you off the ground with WordPress as a submodule just by following a couple of prompts. Have a custom base theme you always start your projects off with? You can install that too, either straight from GitHub or by pointing me to a tarball. Other things I do:

  • Custom directory configuration
  • Install WordPress as a Git submodule for easy version controlled updates
  • Theme init hook for when you install a new theme
  • Permission setting on install
  • Create your database, all you have to do is make me a user
  • Built in Vagrant configuration
  • New Set custom defaults with .yeopress files
  • New Environment based wp-config files, local-config.php

How To Use

If you do not already have the Yeoman toolset installed do so now, and might as well install me at the same time (NOTE: don't type the $):

$ npm install -g yo generator-wordpress

While running if you get errors try running as super user:

$ sudo npm install -g yo generator-wordpress

And run me:

$ yo wordpress

Follow my prompts and WA-BAM....ASCII art!!!!

image

Advanced Usage

By specifying the --advanced flag you get access to more features:

  • Vagrant: Sets up a Vagrant box using Puppet with all the requirements for running a WordPress site.
  • WP version: Select a specific WordPress version to install
  • Block external requests: Adds the WP_HTTP_BLOCK_EXTERNAL setting to config to lock down the admin
  • Add core files to gitignore: Adds rules to the .gitignore file for the WordPress core files

Reusing common settings

You probably want to be able to quickly zip through your install with similar settings for every project. For example, you probably always want to use git but the default is no git. You can define any custom defaults you want in ~/.yeopress. This file is just a json file with key-value pairs for the config settings you want. Here is an example:

{
	"git": true,
	"dbHost": "localhost",
	"dbName": "yeopress",
	"dbUser": "yeopress",
	"dbPass": "yeopress"
}

For a full example, open up the local .yeopress file that is created by the generator. This file is located in the directory you ran yo wordpress in.

Installing WordPress Plugins

New with v1.4.0 is a subgenerator for installing plugins, yo wordpress:plugin. You can supply a comma delimited list of plugin slugs to download. YeoPress will download and unzip those plugins into your content directory.

Visual Learner??

Watch the video.

ADD Visual Learner? Watch the shorter video.

Also see the wiki

And here is the boring write-up...

Themes

Custom themes can be installed from GitHub or a Tarball. Once installed, they are responsible for their own Gruntfile and related tasks. A basic example template can be found in the template branch of this repo. The example template comes with a few grunt tasks pre-configured:

More information on themes here & here

More Repositories

1

express-openapi

Generate OpenAPI docs for an Express App
JavaScript
98
star
2

nighthawk

A wrapper around Express' router for the browser
JavaScript
55
star
3

setprototypeof

Polyfill for Object.setPrototypeOf
JavaScript
53
star
4

react-express-middleware

Middleware to render a React component on both the server and client
JavaScript
31
star
5

short

URL shortener as a GitHub Action
JavaScript
19
star
6

es2015-packages-best-practices

An example project to illustrate best practices when publishing packages
JavaScript
17
star
7

rabinjs

A pure js implementation of Rabin fingerprinting (aka. content defind chunking)
JavaScript
13
star
8

browser-next-tick

A very small implementation of process.nextTick for the browser using requestAnimationFrame
JavaScript
12
star
9

events-async

A wrapper around the EventEmitter to handle promise based async events
JavaScript
11
star
10

create-express-app

Scaffold an express application
JavaScript
10
star
11

Universal-Forms

A set of libraries based on a universal JSON representation of a form
JavaScript
9
star
12

express-session-passport-cleanup

Clean up after passport when using it with express-session
JavaScript
8
star
13

rufio

A Static Site Generator
JavaScript
7
star
14

datd

A daemon for keeping and hosting Dat Archives
JavaScript
7
star
15

transient

A minimal animation loop implimentation
JavaScript
6
star
16

recursive-escape

Recursivly escape objects and array for use in html
JavaScript
6
star
17

express-todo-api

An module to run an example todo api
JavaScript
6
star
18

combine-reducers

A stand-alone Redux compatible combine reducer fuction
JavaScript
6
star
19

loggerr

A very simple logger
JavaScript
6
star
20

HTML5-Number

HTML5 Number Input (polyfill)
JavaScript
5
star
21

meeting-maker

Create a meeting issue on a schedule
JavaScript
5
star
22

intercept-link-clicks

Intercept link clicks and call a callback
JavaScript
5
star
23

Match-Media-Manager

Library for attaching callback functions to Media Query breakpoints
JavaScript
5
star
24

express-pants

๐Ÿ‘–๐Ÿ‘–๐Ÿ‘–A semi-opinionated framework for Express Apps ๐Ÿ‘–๐Ÿ‘–๐Ÿ‘–
JavaScript
4
star
25

runnable

Export a runnable module
JavaScript
4
star
26

prompt-improved

Prompts for beautiful and configurable node.js CLI interfaces
JavaScript
4
star
27

create-git

Node generator to setup git, a ,gitignore, origin and initial commits
JavaScript
4
star
28

es5-lit-html

A transpiled es5 version of lit-html
JavaScript
3
star
29

Carder

Credit Card Type Indication
JavaScript
3
star
30

csv-view

A simple in browser CSV viewier
JavaScript
3
star
31

async-presentation

A Reveal.js slide deck for my Async Control Flow Presentation
JavaScript
2
star
32

jQuery-Templates

jQuery based rip-off of Underscore templates
JavaScript
2
star
33

cptmpl

Copy and process a template file
JavaScript
2
star
34

logtastic

A logger with featutres
JavaScript
2
star
35

distributed-database

Just exploring distributed stuff
JavaScript
2
star
36

app-server

JavaScript
2
star
37

LeSlide

Label Slide - A text field effect
CSS
2
star
38

recursive-unescape

Recursivly unescape objects and arrays
JavaScript
2
star
39

shush-cli

Keep secrets from people
JavaScript
2
star
40

nvmjs

A JavaScript wrapper around nvm
Shell
2
star
41

Universal-Forms-PHP

The Universal Forms PHP implementation
PHP
2
star
42

micro-router

JavaScript
2
star
43

state-container

A minimial and simple state container for javascript applications
JavaScript
2
star
44

opta

Collect input from a user. CLI, Interactive Prompts, and JS interfaces.
JavaScript
1
star
45

buildjs

Build a js bundle
JavaScript
1
star
46

wesleytodd.com

My personal site
CSS
1
star
47

node-http-benchmarks

A small set of node http benchmarks for testing modifying the req
JavaScript
1
star
48

Unmask

Password (Un)Masking
JavaScript
1
star
49

generator-package

A generator for my modules, if you dont like something about it then go away :)
JavaScript
1
star
50

simple-email-validator

A very simple email validator
JavaScript
1
star
51

array-contains-all

Check if one array contains all the entries of another aray
JavaScript
1
star
52

generator-rufio

A Yeoman generator for Rufio
JavaScript
1
star
53

key-share

Eaisly Share Keys Over The Network
JavaScript
1
star
54

blob-the-builder

A wrapper for using the Blob constructor api
JavaScript
1
star
55

wesleytodd-pg

A singleton wrapper around pg-pool with some helpers
JavaScript
1
star
56

create-package

Scaffold a package
JavaScript
1
star
57

archive-pkgjs-create

An archive of the @pkgjs/create repo. Do not use.
JavaScript
1
star
58

abstract-router-harness

JavaScript
1
star
59

tp

A thread pool for Node.js worker threads
1
star
60

shared-context

Share data with the browser
JavaScript
1
star
61

mwstack

A stack of Express style middleware
JavaScript
1
star
62

create-github-action

Scaffold a github action
1
star
63

babelify-version-test-case

A test case for mis-matched babel versions
JavaScript
1
star
64

docker-pg

A docker container for use in node packages, mostly for tests
JavaScript
1
star
65

actions-testing

This is just a repo for me to test actions stuff
JavaScript
1
star
66

compile-query-parser

The compile query parser function from express
JavaScript
1
star
67

apps-presentation

a presentation about making node apps
JavaScript
1
star
68

safe-parse-list

Safely parse a string into a list
JavaScript
1
star
69

buildcss

Builds css my way
JavaScript
1
star
70

store-settings

Express settings as a standalone module
JavaScript
1
star
71

node-matrix

A GitHub action to update your test action to the latest Node LTS versions
JavaScript
1
star
72

conventional-commits-parser

Parse conventional commits (extracted from https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser)
JavaScript
1
star