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.
Full installation and usage instructions are available in our documentation.
Ensure that Elasticsearch and MySQL are installed and that MySQL is either running or runnable by our backend.sh script and our runserver.sh script.
git clone [email protected]:cfpb/cfgov-refresh.git
cd cfgov-refresh
pip install virtualenv virtualenvwrapper
npm install -g gulp bower
source load-env.sh
source setup.sh
./runserver.sh
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:
git clone [email protected]:cfpb/cfgov-refresh.git
cd cfgov-refresh
pip install virtualenv virtualenvwrapper
source activate-virtualenv.sh
pip install mkdocs
mkdocs serve
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](https://github.com/cfpb/cfgov-refresh/issues/new?body= %23%23%20URL%0D%0D%0D%23%23%20Actual%20Behavior%0D%0D%0D%23%23%20Expected%20Behavior %0D%0D%0D%23%23%20Steps%20to%20Reproduce%0D%0D%0D%23%23%20Screenshot&labels=bug).
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.
This project uses the Capital Framework for its user interface and layout components.