The primary repository for consumerfinance.gov. This Django project includes the front-end assets and build tools, Jinja templates for front-end rendering, code to configure our CMS, Wagtail, and several standalone Django apps for specific parts of the site.
Full installation and usage instructions are available in our documentation.
This quickstart requires a working Docker Desktop installation and git:
git clone https://github.com/cfpb/consumerfinance.gov.git cd consumerfinance.gov
One of the following runtimes:
./build-images.sh && ./helm-install.sh
consumerfinance.gov should now be available at http://localhost:8000.
Our documentation will be available at http://localhost:8888 (docker-compose only).
The Wagtail admin area will be available at http://localhost:8000/admin/,
which you can log into with the credentials
If you would like to browse the documentation locally, you can do so
pip install -r requirements/docs.txt mkdocs serve
Documentation will be available locally at http://localhost:8000/.
Getting the package
Packages are tagged into one of three groups: main Branch -> latest, PRs -> pr-#, and Release -> major.minor.patch. The github SHA of the commit packaged should be listed as a label. To see our Docker image packages you can vist Packages page
We welcome your feedback and contributions. See the contribution guidelines for more details.
Additionally, you may want to consider contributing to the Design System, which is the front-end pattern library used in this project.
Open source licensing info
Credits and references
This project uses Design System as the basis of its user interface and layout components.