https://github.com/luftywiranda13/generator-node-oss
Create a Node.js project with ease
https://github.com/luftywiranda13/generator-node-oss
boilerplate javascript node nodejs scaffold starter-kit template yeoman yeoman-generator
Last synced: 3 months ago
JSON representation
Create a Node.js project with ease
- Host: GitHub
- URL: https://github.com/luftywiranda13/generator-node-oss
- Owner: luftywiranda13
- License: mit
- Created: 2017-08-14T11:11:16.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-06-03T09:18:16.000Z (about 6 years ago)
- Last Synced: 2025-03-29T17:35:50.594Z (about 1 year ago)
- Topics: boilerplate, javascript, node, nodejs, scaffold, starter-kit, template, yeoman, yeoman-generator
- Language: JavaScript
- Homepage:
- Size: 260 KB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# generator-node-oss
> Create a Node.js project with ease
[](https://www.npmjs.com/package/generator-node-oss)
[](https://npm-stat.com/charts.html?package=generator-node-oss&from=2016-04-01)
[](https://travis-ci.org/luftywiranda13/generator-node-oss)
[](https://codecov.io/gh/luftywiranda13/generator-node-oss)
## Why
- Generates a simple but _ready to start_ project
- Includes only necessary tools
- Monitors repo quality through helpful badges
- [Jest testing framework](https://facebook.github.io/jest)
- Sensible [ESLint](http://eslint.org) config bundled in [XO](https://github.com/xojs/xo)
- Automates code reformatting using [Prettier](https://github.com/prettier/prettier)
- [Travis CI](https://travis-ci.org) configuration
- [Issue, Pull Request, and Contributing templates](https://github.com/blog/2111-issue-and-pull-request-templates) _(optional)_
- [Supports ES2015+ using Babel](https://babeljs.io) _(optional)_
## Installation
```sh
npm install --global yo generator-node-oss
```
## Usage
```sh
yo node-oss
```
With the most basic options, youʼll get a project structured like this:
```sh
$ tree
.
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .travis.yml
├── index.js
├── license
├── package.json
├── readme.md
└── test.js
```
Less boilerplate 🎉
## FAQ
### How to upgrade existing project scaffolded with Yeoman?
Read how to do it [here](https://stackoverflow.com/a/18500003).
## Related
- [generator-bunny](https://github.com/luftywiranda13/generator-bunny) － Supports ES2015+ and [Flow](https://flow.org) by default
- [generator-kcd-oss](https://github.com/kentcdodds/generator-kcd-oss) － Lots of features but many things left untouched
- [generator-nm](https://github.com/sindresorhus/generator-nm) － A way simpler Yeoman generator
## License
MIT © [Lufty Wiranda](https://www.instagram.com/luftywiranda13)