generator-cf

Yeoman generator for Capital Framework.

Installation

Install Yeoman and the Capital Framework generator:

npm install -g yo generator-cf

Usage

Create a new project directory and cd to it:

mkdir my-new-project && cd $_

Run the Capital Framework generator:

yo cf

Compile the assets:

gulp

A demo page is generated at:

./dist/index.html

To view this page, run a simple server so that the assets resolve correctly:

cd ./dist/
python -m SimpleHTTPServer

And visit http://localhost:8000/ in a web browser.

Build your project!

Contributing

To hack on this generator, fork this repo, clone it and use npm link:

$ cd generator-cf
$ npm link
$ cd some-empty-directory-somewhere
$ npm link generator-cf
$ yo cf

Edit the source files and re-run yo cf to see the changes. Please modify the current tests or write new tests if you add functionality to the generator. Tests can be executed by running npm test from the project's root.

---

Open source licensing info

1. TERMS
2. LICENSE
3. CFPB Source Code Policy