Skip to content

HealthStarInformatics/cfgov-refresh

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cfgov-refresh

Build Status codecov

The master 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.

Quickstart

Full installation and usage instructions are available in our documentation.

This project requires Python 2.7, Node 8, 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/cfgov-refresh.git

Create a virtual environment for Python dependencies:

cd cfgov-refresh
mkvirtualenv --python=python2.7 cfgov-refresh

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.

Documentation

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/.

Getting help

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.

Getting involved

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.

Open source licensing info

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

Credits and references

This project uses Capital Framework as the basis of its user interface and layout components.

Packages

No packages published

Languages

  • Python 52.1%
  • HTML 24.2%
  • JavaScript 13.1%
  • CSS 8.4%
  • Gherkin 2.0%
  • Shell 0.1%
  • Dockerfile 0.1%