Tools to help students make informed financial decisions about college.

• Status: Alpha
• This project is under construction. Please wear a hardhat.

• solr
• pip
• virtualenv
• virtualenvwrapper
• node
• gulp

• Django
• requests
• Unipath
• haystack
• pysolr

• mock
• coverage
• selenium
• behave
• PyHamcrest

This project is not fully functional, but feel free to give it a spin. Here's how:

• Install the setup dependencies if you don't have them. Make sure you have solr installed and running.
• Go to the local directory where you want the project to be created, make a virtual environment, clone this repository (or your own fork of it).

mkvirtualenv college-costs
git clone https://github.com/cfpb/college-costs.git .
setvirtualenvproject

• Set up front-end resources and database assets:

./local_setup.sh

• Move to the paying_for_college directory and fire up a local server:

cd 'paying_for_college'
python manage.py runserver

The college-cost tools should show up at http://127.0.0.1:8000/paying-for-college/

The app is set up to run as a component of CFPB's website, consumerfinance.gov, so if you run it locally, some fonts and font-related icons may not load because of Cross-Origin Resource Sharing policies.

You can run python tests from the project root with this command:

. pytest.sh

If you find a bug or see a way to improve the project, we'd love to hear from you. Add an issue, or fork the project and send us a pull request with your suggested changes.

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

This project is based on the current CFPB Paying for College suite of tools for students.