https://github.com/jneidel/generator-jneidel
Opinionated collection of boilerplates
https://github.com/jneidel/generator-jneidel
boilerplate scaffold-generator yeoman yeoman-generator
Last synced: 3 months ago
JSON representation
Opinionated collection of boilerplates
- Host: GitHub
- URL: https://github.com/jneidel/generator-jneidel
- Owner: jneidel
- License: mit
- Created: 2018-02-23T13:59:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-08T21:36:45.000Z (almost 6 years ago)
- Last Synced: 2025-03-24T15:59:56.672Z (3 months ago)
- Topics: boilerplate, scaffold-generator, yeoman, yeoman-generator
- Language: JavaScript
- Homepage:
- Size: 99.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# generator-jneidel
> Opinionated collection of boilerplates
[](https://travis-ci.org/jneidel/generator-jneidel)
[](https://github.com/jneidel/generator-jneidel/blob/master/license)
[](https://www.npmjs.com/package/generator-jneidel)
Boilerplates available for creating:
- node module
- chrome extension
- node webapp
- cli module
- static site
## Install
Boilerplates can be installed manually or using [Yeoman](https://github.com/yeoman/yo) (recommended) as a scaffolding tool.
### Install manually
```zsh
# 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
[](https://www.npmjs.com/package/generator-jneidel)
```
$ npm install -g generator-jneidel yo
```
## Usage
With [yo](https://www.npmjs.com/package/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](https://github.com/sindresorhus/node-module-boilerplate) and [sindresorhus/generator-nm](https://github.com/sindresorhus/generator-nm).
## License
MIT © [Jonathan Neidel](https://jneidel.com)