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 documentation for this project is available in the docs/ directory and online.
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:
-
Set up and run the Docker containers via docker-compose:
docker-compose up
-
Set up and run the Docker containers via Kubernetes via Helm:
./build-images.sh && ./helm-install.sh
if you see an error like:
Error: Kubernetes cluster unreachable: Get "http://localhost:8080/version": dial tcp [::1]:8080: connect: connection refusedthen you need to activate Kubernetes in your docker desktop settings!
This may take some time, as it will also load initial data and build the frontend.
-
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 admin/admin.
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
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 Design System, which is the front-end pattern library used in this project.
This project uses Design System as the basis of its user interface and layout components.