:warning: THIS REPO IS DEPRECATED (June 3, 2021) :warning:

Please find the source code moved to https://github.com/cfpb/consumerfinance.gov/tree/main/cfgov/retirement_api

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 -e '.[testing]'

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 retirement_api/fixtures/retiredata.json

Fire up a development server.

python manage.py runserver

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

Fonts

This application uses a proprietary licensed font (Avenir Next) that is not included in this repository.

By default it will try to load this font from the Fonts.com content delivery network (CDN). This behavior can be modified to instead try to load the font locally from the retirement_api/static/retirement/webfonts/ directory by setting @use-font-cdn to false and rebuilding the assets with gulp build. Restart the local web server once you've made this change.

For Bureau employees or others with access to our private fonts repository, you can perform this step by creating a symbolic link to your local copy of the font files:

ln -s /path/to/cfgov-fonts/fonts/ retirement_api/static/retirement/webfonts

Usage notes

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

To run the Python tests, install tox and then run it:

tox

You can run the JavaScript tests with:

npm test

Additional documentation

Front-end documentation

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.

cfpb / retirement

readme