https://github.com/cfpb/generator-cf

Yeoman generator for Capital Framework
https://github.com/cfpb/generator-cf

capital-framework

Last synced: 17 days ago
JSON representation

Yeoman generator for Capital Framework

• Host: GitHub
• URL: https://github.com/cfpb/generator-cf
• Owner: cfpb
• License: cc0-1.0
• Created: 2014-10-27T16:48:22.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-05-09T21:24:39.000Z (over 5 years ago)
• Last Synced: 2024-11-19T23:41:52.417Z (about 1 month ago)
• Topics: capital-framework
• Language: HTML
• Homepage: http://cfpb.github.io/capital-framework/getting-started/
• Size: 1.06 MB
• Stars: 9
• Watchers: 13
• Forks: 13
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-cf [![Build Status](https://secure.travis-ci.org/cfpb/generator-cf.png?branch=master)](https://travis-ci.org/cfpb/generator-cf)

[Yeoman](http://yeoman.io) generator for [Capital Framework](http://cfpb.github.io/capital-framework/).

![generator-cf screenshot](https://raw.githubusercontent.com/cfpb/generator-cf/master/screenshot.gif)

## Installation

Install Yeoman and the Capital Framework generator:

```bash

npm install -g yo generator-cf

```

## Usage

Create a new project directory and `cd` to it:

```bash

mkdir my-new-project && cd $_

```

Run the Capital Framework generator:

```bash

yo cf

```

Compile the assets:

```bash

gulp

```

A demo page is generated at:

```bash

./dist/index.html

```

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

```bash

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`:

```bash

$ 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](TERMS.md)

2. [LICENSE](LICENSE)

3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)