The redesign of the www.consumerfinance.gov website. This Django project includes the front-end assets and build tools, Jinja templates for front-end rendering, and Wagtail CMS for content administration.
Full installation and usage instructions are available in our documentation.
Ensure that Python, Node, Docker, Docker Machine, Docker Compose, and imagemagick are installed. If you are using a mac with homebrew, you can run homebrew-deps.sh as described below:
git clone git@github.com:cfpb/cfgov-refresh.git
cd cfgov-refresh
sh homebrew-deps.sh
pip install virtualenv virtualenvwrapper
npm install -g gulp
source load-env.sh
source setup.sh
workon cfgov-refresh
./runserver.sh
Documentation for this project is available in the docs directory and online.
If you would like to browse the documentation locally, you can do so
with mkdocs:
git clone git@github.com:cfpb/cfgov-refresh.git
cd cfgov-refresh
pip install virtualenv virtualenvwrapper
source activate-virtualenv.sh
pip install mkdocs
mkdocs serve
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.
We welcome your feedback and contributions. See the contribution guidelines for more details.
Additionally, you may want to consider contributing to the Capital Framework, which is the front-end pattern library used in this project.
This project uses the Capital Framework for its user interface and layout components.