Retirement: Before You Claim

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

Status: Beta

Edición español

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

Setup dependencies

Code dependencies

For Python testing

For browser testing

Installation

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.

npm install
grunt Build

(You can also run grunt watch to have the build run automatically after edits to JavaScript source files, HTML templates, and assets in retirement_api/static/retirement. livereload is turned on if you have a LiveReload browser extension.)

Load the app's database tables and content.

python manage.py syncdb
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/before-you-claim/.

Usage notes

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.

How to run software tests

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

nosetests --with-coverage --config=.coveragerc --cover-package retirement_api

Getting involved

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.

marteki/retirement