generator-jneidel v1.3.0

generator-jneidel

Opinionated collection of boilerplates

Boilerplates available for creating:

• node module
• chrome extension
• node webapp
• cli module
• static site

Install

Boilerplates can be installed manually or using Yeoman (recommended) as a scaffolding tool.

Install manually

# node module
$ curl -fsSL https://github.com/jneidel/generator-jneidel/archive/master.tar.gz | tar -xz --strip-components=4 generator-jneidel-master/generators/app/templates

# To download a different boilerplate replace 'app' in the command above, with one of these:
# [ chrome, cli, static, web, web-lite ]

Install using Yeoman

$ npm install -g generator-jneidel yo

Usage

With yo:

node module:

$ yo jneidel

chrome extension:

$ yo jneidel:chrome

webapp:

$ yo jneidel:web

cli:

$ yo jneidel:cli

static website:

$ yo jneidel:static

webapp (lite):

$ yo jneidel:web-lite

Assumptions

These boilerplates assume, that you're using:

• MIT license
• Ava (testing framework)
• Travis (CI)
• Webpack (build system)
• Scss (CSS)
• Pug (HTML)
• NPM (package manager)
• GitHub (git hosting)

Test

$ npm run test

Attribution

Inspired by sindresorhus/node-module-boilerplate and sindresorhus/generator-nm.

License

MIT © Jonathan Neidel