generator-node

Yeoman generator for Node projects.

This generator provides the following features:

• src folder as a starter point to build your project.
• EditorConfig to help you define and maintain consistent coding styles between different editors.
• ESLint to provide a pluggable linting utility for JavaScript.
• Prettier as an opinionated code formatter.
• README.md and CHANGELOG.md with information about the project, installation, usage, development, author and license.
• Badges for License.

Project files

.
|--- src
|    |--- index.js
|--- .editorconfig
|--- .eslintignore
|--- .eslintrc.json
|--- .gitattributes
|--- .gitignore
|--- .npmrc
|--- .prettierrc
|--- CHANGELOG.md
|--- LICENSE
|--- package.json
|--- README.md

Installation

• Install Yeoman

$ npm install -g yo

• Install Generator

$ npm install -g @robertoachar/generator-node

Usage

• Creating a project

# Create a directory for your project
$ mkdir awesome-project

# Change into directory
$ cd awesome-project

# Generate a project
$ yo # choose @robertoachar/node

• Running project

Action	Usage
Starting development mode	npm start
Linting code	npm run lint

Development

Prerequisites

• Install Node.js
• Install npm
• Install Yeoman CLI

$ npm install -g yo

Clone the repo

$ git clone https://github.com/robertoachar/generator-node.git

Run generator

# Change into directory
$ cd generator-node

# Link generator
$ npm link

# Run generator
$ yo # choose @robertoachar/node

Author

Roberto Achar

License

MIT