Skip to content
Helping Americans make choices about retirement
HTML Python JavaScript CSS Other
Branch: master
Clone or download
Latest commit 4aa8a11 Sep 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add GH templates Jul 19, 2018
browser_testing Replace print statements with logging Sep 19, 2018
config Modernize build | Update cf-icons to v10 | remove some jquery May 31, 2019
gulp Fix linter errors Nov 7, 2018
retirement_api Update about page heading Sep 11, 2019
settings Override standalone settings while testing Sep 19, 2018
src Update English content Sep 9, 2019
test Modernize retirement app Jul 12, 2018
.coveragerc add django 1.11 support to this project Jul 18, 2018
.eslintignore gulp lint fixed Mar 25, 2016
.eslintrc Modernize retirement app Jul 12, 2018
.gitattributes Use merge=union for CHANGELOG.md in .gitattributes file Mar 17, 2016
.gitignore Add certain Python-related files to .gitignore Jun 21, 2019
.npmrc changes recommended by vax Apr 11, 2016
.snyk Update dependencies with Snyk's wizard May 14, 2018
.travis.yml Add Python3 to tox and Travis Jun 21, 2019
CHANGELOG.md Deprecate CHANGELOG in favor of Github releases Sep 27, 2018
CONTRIBUTING.md Documenting browser support Mar 19, 2018
LICENSE Use official CC0 plain text legal code Sep 2, 2014
MANIFEST.in ignore webfonts when packaging Nov 9, 2018
README.md change default webfont loading to use CDN Nov 16, 2018
TERMS.md Add language about CFPB contribs. to a joint work Aug 21, 2014
front-end.md Modernize retirement app Jul 12, 2018
frontendbuild.sh Updates to latest Capital Framework | Remove bower Nov 7, 2018
gulpfile.js Update gulp build process to 4 workflow May 8, 2018
manage.py Override standalone settings while testing Sep 19, 2018
package-lock.json Modernize build | Update cf-icons to v10 | remove some jquery May 31, 2019
package.json Modernize build | Update cf-icons to v10 | remove some jquery May 31, 2019
retirement_screenshot.png update screenshots Mar 24, 2016
setup.py Update setup.py with Python 3 information Jun 21, 2019
spanish_screenshot.png update screenshots Mar 24, 2016
tox.ini Add Python3 to tox and Travis Jun 21, 2019

README.md

Build Status Coverage Status

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

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.


Open source licensing info

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

You can’t perform that action at this time.