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 -
Set up and run the Docker containers:
docker-compose up
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.
The Wagtail admin area will be available at http://localhost:8000/admin/,
which you can log into with the credentials admin/admin.
Full documentation for this project is available in the docs/ directory and online.
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.