Skip to content
🔧 Yeoman generator for Node projects.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
generators/app
test
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.npmrc
.prettierrc
.travis.yml
CHANGELOG.md
LICENSE
README.md
appveyor.yml
circle.yml
package.json

README.md

generator-node

Travis Status AppVeyor Status CircleCI Status Coveralls Status NPM Version License

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

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

# Change into directory
$ cd awesome-project

# Generate a project
$ yo @robertoachar/node
  • Run project
Action Usage
Start development mode npm start
Lint code npm run lint

Development

Prerequisites

$ 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 @robertoachar/node

Author

Roberto Achar

License

MIT

You can’t perform that action at this time.