{"id":13905297,"url":"https://github.com/cfpb/retirement","last_synced_at":"2026-01-11T02:51:05.927Z","repository":{"id":27598913,"uuid":"31082299","full_name":"cfpb/retirement","owner":"cfpb","description":"Helping Americans make choices about retirement","archived":true,"fork":false,"pushed_at":"2021-06-03T21:27:11.000Z","size":10397,"stargazers_count":23,"open_issues_count":14,"forks_count":26,"subscribers_count":43,"default_branch":"main","last_synced_at":"2024-11-25T13:38:21.542Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.consumerfinance.gov/retirement/before-you-claim/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cfpb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-20T19:53:05.000Z","updated_at":"2024-10-05T17:51:14.000Z","dependencies_parsed_at":"2022-09-02T22:42:10.473Z","dependency_job_id":null,"html_url":"https://github.com/cfpb/retirement","commit_stats":null,"previous_names":[],"tags_count":73,"template":false,"template_full_name":null,"purl":"pkg:github/cfpb/retirement","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fretirement","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fretirement/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fretirement/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fretirement/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cfpb","download_url":"https://codeload.github.com/cfpb/retirement/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fretirement/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265692376,"owners_count":23812197,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T23:01:13.355Z","updated_at":"2026-01-11T02:51:05.861Z","avatar_url":"https://github.com/cfpb.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# :warning: THIS REPO IS DEPRECATED (June 3, 2021) :warning:\n\nPlease find the source code moved to https://github.com/cfpb/consumerfinance.gov/tree/main/cfgov/retirement_api\n\n---\n\n![Build Status](https://github.com/cfpb/retirement/workflows/ci/badge.svg)[![Coverage Status](https://coveralls.io/repos/cfpb/retirement/badge.svg)](https://coveralls.io/r/cfpb/retirement)\n\n# Retirement: Before You Claim\n\nThis is a project aimed at helping Americans make choices about retirement, including when to claim Social Security benefits.\n  - **Status**: Beta\n\n![](retirement_screenshot.png)\n\n\n## [Edición español](http://www.consumerfinance.gov/retirement/before-you-claim/es/)\n\n![](spanish_screenshot.png)\n\nTú puedes ver este app en español por poner `/es` al parte final del url.  \n(You can view this app in Spanish by adding `/es` to the end of the url.)\n\n\n### Setup dependencies\n * [pip](https://pypi.python.org/pypi/pip)\n * [virtualenv](https://virtualenv.pypa.io/en/latest/)\n * [virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/)\n * [Node](http://nodejs.org/)\n * [Gulp](http://gulpjs.com/)\n * [Bower](https://bower.io/)\n\n### Code dependencies\n * [Django 2.2](https://docs.djangoproject.com/en/2.2/)\n * [BeautifulSoup4](http://www.crummy.com/software/BeautifulSoup/bs4/doc/)\n * [Python-dateutil](https://dateutil.readthedocs.org/en/latest/)\n * [Requests](http://docs.python-requests.org/en/latest/)\n\n### For Python testing\n * [mock](https://mock.readthedocs.org/en/latest/)\n * [coverage](http://nedbatchelder.com/code/coverage/)\n\n### For browser testing\n* [selenium](http://selenium.googlecode.com/svn/trunk/docs/api/py/index.html)\n* [behave](http://pythonhosted.org/behave/)\n* [pyhamcrest](https://pyhamcrest.readthedocs.org/)\n\n### Installation\nThe 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:\n\nGo 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.\n```bash\nmkvirtualenv retirement\ngit clone https://github.com/cfpb/retirement.git\ncd retirement\nsetvirtualenvproject\npip install -e '.[testing]'\n```\n\nBuild the front-end requirements and the JavaScript files.\n```bash\n./frontendbuild.sh\n```\n\nCreate a standalone database and load the app's tables and content.\n```bash\npython manage.py migrate\npython manage.py loaddata retirement_api/fixtures/retiredata.json\n```\n\nFire up a development server.\n```bash\npython manage.py runserver\n```\n\nThe \"Before You Claim\" page should load at [localhost:8000/before-you-claim/](http://localhost:8000/before-you-claim).\n\n### Fonts\nThis application uses a proprietary licensed font (Avenir Next) that is not included in this repository.\n\nBy default it will try to load this font from the Fonts.com content delivery network (CDN).\nThis behavior can be modified to instead try to load the font locally from\nthe `retirement_api/static/retirement/webfonts/` directory by setting\n[`@use-font-cdn`](https://github.com/cfpb/retirement/blob/main/src/css/main.less#L29)\nto `false` and rebuilding the assets with `gulp build`. Restart the local web server\nonce you've made this change.\n\nFor Bureau employees or others with access to our private fonts repository,\nyou can perform this step by creating a symbolic link to your local copy of\nthe font files:\n\n```sh\nln -s /path/to/cfgov-fonts/fonts/ retirement_api/static/retirement/webfonts\n```\n\n### Usage notes\n- The app sends http requests to the Social Security Administration's [Quick Calculator](http://www.ssa.gov/OACT/quickcalc/index.html) to get benefit estimates for the chart.\n\n### How to run software tests\n- To run the Python tests, install [tox](https://tox.readthedocs.io/en/latest/) and then run it:\n\n```bash\ntox\n```\n\n- You can run the JavaScript tests with:\n\n```bash\nnpm test\n```\n\n## Additional documentation\n* [Front-end documentation](front-end.md)\n\n## Getting involved\nIf you find a bug or see a way to improve the project, we'd love to hear from you.\nAdd an issue, or fork the project and send us a pull request with your suggested changes.\n\n----\n\n## Open source licensing info\n1. [TERMS](TERMS.md)\n2. [LICENSE](LICENSE)\n3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)\n\n\n----\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fretirement","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcfpb%2Fretirement","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fretirement/lists"}