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 project requires Python 3.6, Node 14, and Gulp 4. We recommend the use of virtualenv and virtualenvwrapper for keeping the project's Python dependencies contained.

Clone the repository:

git clone [email protected]:cfpb/consumerfinance.gov.git

Create a virtual environment for Python dependencies:

cd consumerfinance.gov
mkvirtualenv --python=python3.6 consumerfinance.gov

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, a Wagtail admin user, and a site homepage:

./initial-data.sh

Start your local Django server:

./runserver.sh

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

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.

If you would like to browse the documentation locally, you can do so with mkdocs:

pip install -r requirements/docs.txt
mkdocs serve

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

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.

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

This project uses Design System as the basis of its user interface and layout components.