generator-node-cfpb

Yeoman generator for CFPB node modules.

Installation

Install this generator by running: npm install -g generator-node-cfpb.

Usage

At the command-line, cd into an empty directory, run this command and follow the prompts.

yo node-cfpb

Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.

Contributing

Please read the Contributing guidelines.

Running Tests

To run tests, first install mocha and any dependencies via npm:

npm install

Run tests with:

npm test

License

The project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Software source code previously released under an open source license and then modified by CFPB staff is considered a "joint work" (see 17 USC § 101); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open-source license.

For further details, please see: http://www.consumerfinance.gov/developers/sourcecodepolicy/