Django project protecting American consumers
Switch branches/tags
acceptance-tests add-aria-label-to-links add-docker-mac-internal-ip add-regdown agreements-api app_scripts ask-article-page ask-block ask-cfpb-block ask-comparisons ask-export-encoding ask-export ask-metadata-block ask-tagged-content-page automate-webpagetest axe-core-test bfl-test-drf breadcrumbs-icon-update browser-test-local-url-options browser-test-update browsersync careers-email-signup-prototype careers-wagtail-components complaint-landing cucumber-demo delay_menu2 dev-dockerfile dfjr_1075_header_tests django-19-migrations-take-2 docker-gulp docker-use-apache enhanced-cms-front-end even-simpler-beta-drafts explore_rates_updates_review external-link-front-end external-links-search fake-setup feedback-form-replacement fix-1805 fix-chart-builder-http fix-disabled-link-markup flagable-pages flagged-page flat-export full-width-borders gh-pages govdelivery-phone-numbers gulp-as-npm-script hide_menu_vo housing-counselor-updates ie-cors-fix job-aggregator-feeds job-metadata lighthouse links-inventory links-search-error-handling master mega-menu-wagtail meta-description migrate_kbyo minify-html more-robust-split-testing mouseflow-csp move-paying-for-college mp-api-elasticsearch multistage-experiment nest-mobile-mega-menu-button-in-h2 new-acceptance-tests oah-process-ask-breadcrumbs oah_style_updates offline-housing-pdfs-2 offline-housing-pdfs optimize-queries pa11y-test pdf permissions-audit pfc-and-fin-ed-redirects pk-condition postgres-migrator pr/4430 py3-agreements py3-jobmanager reduce-avenir-files regs3k-fix-reverse-tests regs3k-interp regs3k-preprocess regs3k-recent-notices regs3k-search-indexes regs3k-search-page regs5k-emdash regulations3000 remove-ask-model-ref remove-avenir-next-except-regular remove-avenir-next-italic-demibold remove-avenir-next-italic remove-avenir-next remove-avenir-web-font remove_jest_cli remove resolve-gh-issues-script restrict-ask-snippet-options scope_css script_async skip-nav snippet-list-updates snippet-model-admin snyk-fix-837e22f4 squash-v1-migrations test-run-dj111 test_sitespeedio_travis test_update text-input-for-search timelinejs_in_apps transpile_check travis-faster-backend travis-testing treedommodel update-expandables-reg3k update-expandables-regs3k update-readme update_fax_var updates_date_format upgrade-chart-builder-for-inquiries-release use-cf-forms wip-a11y-testing yarn-docker yarn-impl
Nothing to show
Clone or download
CFPBot Merge pull request #4665 from chosak/no-more-mappings
Remove obsolete es_mappings directory
Latest commit 3fc5d71 Dec 7, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update PULL_REQUEST_TEMPLATE.md Mar 15, 2018
cfgov remove obsolete es_mappings directory Dec 7, 2018
collectstatic Alters the 'sheerlike' package to deal with running multiple, Feb 18, 2016
config Convert JS to use ES6 modules Nov 26, 2018
develop-apps Let's just go all the way with Docker Oct 26, 2017
docker/elasticsearch Add language-specific synonym files for Elasticsearch Nov 20, 2017
docs Merge branch 'master' into yarn-impl Dec 6, 2018
gulp Remove legacy timelinejs from KBYO Oct 25, 2018
npm-packages-offline-cache freshen lockfile Dec 7, 2018
requirements [TDP] Bump release version from 1.0.26 to 1.0.27 Dec 6, 2018
scripts Prevent `npm install` via preinstall script Oct 9, 2018
static.in add static.in directory Nov 7, 2017
test Creates FormModel class and adds initial FilterableListControls tests Nov 30, 2018
.dockerignore Let's just go all the way with Docker Oct 26, 2017
.env_SAMPLE Allow setting AWS_S3_CUSTOM_DOMAIN via environment Oct 31, 2018
.eslintrc Change line length to error to warning Jul 9, 2018
.flake8 remove obsolete es_mappings directory Dec 7, 2018
.gitignore Add package-lock.json to .gitignore Oct 9, 2018
.isort.cfg Move Housing Counselor from legacy into its own app Nov 6, 2018
.nojekyll Initial commit, copies files from cf-demo. Apr 21, 2014
.npmrc npm shrinkwrap and snyk (#1862) Apr 11, 2016
.travis.yml Merge branch 'master' into yarn-impl Dec 6, 2018
.yarnrc Refreeze yarn.lock Nov 27, 2018
CHANGELOG.md minor CHANGELOG updates Feb 7, 2017
CONTRIBUTING.md Copy editing Oct 2, 2018
Dockerfile Combine traditional & docker env files Jul 30, 2018
INSTALL.md Grammar, cleanup, links, and formatting Aug 11, 2016
LICENSE Documentation updates Dec 29, 2014
README.md fix docs error and sqlite reference in readme Jul 31, 2018
TERMS.md Add yarn install docs and note to TERMS Sep 25, 2018
TEST.md Grammar, cleanup, links, and formatting Aug 11, 2016
activate-virtualenv.sh Tweaks to enable existing scripts to work with new setup Oct 12, 2017
attach.sh Simplify scripts and docs related to local docker-compose setup May 17, 2018
babel.config.js Convert JS to use ES6 modules Nov 26, 2018
backend.sh Remove production environment setting in backend.sh May 30, 2018
code.json Update code.json to 2.0.0 schema (#4269) Jun 26, 2018
codecov.yml Minor fixes May 22, 2018
docker-compose.yml Combine traditional & docker env files Jul 30, 2018
extend-environment.sh update shell scripts Oct 30, 2017
frontend.sh minor npm -> yarn renames and excision of dep hashing Sep 25, 2018
gulpfile.js Update test config Aug 10, 2018
homepage.png Update the readme image to lose the 'beta' banner Sep 30, 2016
initial-data.sh update shell scripts Oct 30, 2017
jest.config.js Separate Regs3K search page concerns Jul 23, 2018
mac-virtualbox-init.sh Move docker check Dec 11, 2017
mkdocs.yml Add split testing doc to the docs menu Dec 4, 2018
package.json core-js and fancy-log are true deps; this reflects that Dec 7, 2018
refresh-data.sh Match deploy process used in ansible-consumer-finance Jul 31, 2018
runserver.sh Add default value for DJANGO_HTTP_PORT if not set May 17, 2018
setup.sh Remove references to .python_env Sep 6, 2018
shell.sh Combine traditional & docker env files Jul 30, 2018
show_coverage.sh Add deployment smoke-test scripts Oct 17, 2016
tox.ini cleanup django 1.8 references in tox.ini Oct 9, 2018
travis_install.sh Reduce Travis queue by moving docs deploy to it's own stage Jul 5, 2018
travis_run.sh Merge branch 'master' into yarn-impl Nov 28, 2018
yarn.lock freshen lockfile Dec 7, 2018

README.md

cfgov-refresh

Build Status codecov

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.

Screenshot of cfgov-refresh

Quickstart

Full installation and usage instructions, including those for an alternative Docker-based local setup, are available in our documentation.

This project requires Python 2.7, Node 8, and Gulp 4. We recommend the use of virtualenv and virtualenvwrapper.

Clone the repository:

git clone git@github.com:cfpb/cfgov-refresh.git

Create a virtual environment for Python dependencies:

cd cfgov-refresh
mkvirtualenv --python=python2.7 cfgov-refresh

Create and load initial environment settings:

cp -a .env_SAMPLE .env
source .env

Install third-party dependencies and build frontend assets:

./setup.sh

Create a local database and add some basic pages:

./initial-data.sh

Start your local Django server:

./runserver.sh

Your site will be available locally at http://localhost:8000.

The site admin will be available at http://localhost:8000/admin/, using login admin / admin.

Documentation

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

pip install -r requirements/manual.txt
mkdocs serve

Documentation will be available locally at http://localhost:8000.

Getting help

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.

Getting involved

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.

Open source licensing info

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

Credits and references

This project uses the Capital Framework for its user interface and layout components.