This is a project aimed at helping Americans make choices about retirement, including when to claim Social Security benefits.

• Status: Beta

Tú puedes ver este app en español por poner /es al parte final del url.
(You can view this app in Spanish by adding /es to the end of the url.)

• pip
• virtualenv
• virtualenvwrapper
• Node
• Gulp

• Django 1.8
• BeautifulSoup4
• Python-dateutil
• Requests
• lxml

• mock
• coverage

• selenium
• behave
• pyhamcrest

The tool is a Django module, intended to be installed in a larger Django project. But it can run on its own in a Mac or Linux environment, assuming you have the setup dependencies of pip, virtualenv and virtualenvwrapper installed. Here's how:

Go to where you want the project to be created, make a virtual environment, clone this repository (or your own fork of it) and install requirements and settings.

mkvirtualenv retirement
git clone https://github.com/cfpb/retirement.git
cd retirement
setvirtualenvproject
pip install -r requirements.txt
cp test_settings.py settings.py

Build the front-end requirements and the JavaScript files.

./frontendbuild.sh

Create a standalone database and load the app's tables and content.

python manage.py migrate
python manage.py loaddata retiredata.json

Fire up a development server.

python manage.py runserver

The "Before You Claim" page should load at localhost:8000/retirement/before-you-claim/.

• The app is set up to run inside consumerfinance.gov, so if you run it locally, some fonts may not load because of Cross-Origin Resource Sharing policies.
• The app sends http requests to the Social Security Administration's Quick Calculator to get benefit estimates for the chart.

• You can use nose to run the Python test suite and see code coverage information:

  ./pytest.sh

• You can run the JavaScript tests with:

  npm test

• Front-end documentation

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