https://github.com/tj/ngen

nodejs project generator
https://github.com/tj/ngen

Last synced: 3 months ago
JSON representation

nodejs project generator

• Host: GitHub
• URL: https://github.com/tj/ngen
• Owner: tj
• Created: 2011-03-04T19:30:24.000Z (almost 15 years ago)
• Default Branch: master
• Last Pushed: 2013-06-10T22:10:42.000Z (over 12 years ago)
• Last Synced: 2025-03-27T17:36:41.099Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 204 KB
• Stars: 167
• Watchers: 6
• Forks: 33
• Open Issues: 3
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

          

# NGen

 NGen is a nodejs package generator, complete with best practices, package structure, package.json and more.

## Installation

    $ npm install ngen

## Usage

    Usage: ngen [options] [path]

    Options:

      -t, --template    Use the template 

      -d, --directory   Use the template directory 

      -V, --version           Output the current version

      -h, --help              Display help information

## Templates

### Default

 Currently the only available template, creating the following structure populated with content after the following questions are asked from the cli:

       Project name: foo

       Enter your name: TJ Holowaychuk

       Enter your email: tj@vision-media.ca

       Project description: awesome foo-ness

structure:

 

     ./History.md

     ./Readme.md

     ./index.js

     ./lib/.js

     ./test/.test.js

     ./support

     ./Makefile

     ./package.json

## License 

(The MIT License)

Copyright (c) 2011 TJ Holowaychuk <tj@vision-media.ca>

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.