CFPB eProcurement

Prototypes to help CFPB procure things more easily! This site is published automatically by 18F Pages.

Dependencies

Jekyll: the static site generator
Grunt: task runner for pulling in assets, linting and concatenating code, etc.
Less: CSS pre-processor.
Capital Framework: User interface pattern-library produced by the CFPB.
tagalong makes it easy to write progressively enhanced data templates in plain old, semantic HTML.

NOTE: If you're new to Capital Framework, we encourage you to start here.

Installation

Install Node.js however you'd like.
Install Grunt

npm install -g grunt-cli

Next, install the dependencies and compile the project with:

./setup.sh

NOTE: To re-install and rebuild all the site’s assets run ./setup.sh again. See the usage section on updating all the project dependencies.

Configuration

If the software is configurable, describe it in detail, either here or in other documentation to which you link.

Usage

This is a Jekyll site. To view it locally, run one of the following:

jekyll serve
# or
npm start

Each time you fetch from the upstream repository (this repo), run ./setup.sh. This setup script will remove and re-install the project dependencies and rebuild the site's JavaScript and CSS assets.

To watch for changes in the source code and automatically update the running site, open a terminal and run:

grunt watch

Alternatively, if you don't want to run the full watch task, there are three available sub-tasks:

# Watch & compile CSS only
grunt watch:css

# Watch & compile JS only
grunt watch:js

# Watch & compile CSS & JS only
grunt watch:cssjs

How to test the software

TODO

Known issues

Document any known significant shortcomings with the software.

Getting help

Instruct users how to get help with this software; this might include links to an issue tracker, wiki, mailing list, etc.

Use the issue tracker to follow the development conversation. If you find a bug not listed in the issue tracker, please file a bug report.

Open source licensing info

Credits and references

Projects that inspired you
Related projects
Books, papers, talks, or other sources that have meaniginful impact or influence on this project

isabella232 / cfpb-eprocurement Goto Github PK