{"id":15914531,"url":"https://github.com/bbengfort/jobs-report","last_synced_at":"2025-04-03T03:44:23.558Z","repository":{"id":28102510,"uuid":"31600801","full_name":"bbengfort/jobs-report","owner":"bbengfort","description":"Visualization of the monthly jobs report by the BLS","archived":false,"fork":false,"pushed_at":"2015-05-13T20:02:24.000Z","size":7009,"stargazers_count":5,"open_issues_count":21,"forks_count":5,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-02-08T17:45:50.251Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://elmr.herokuapp.com/","language":"PLpgSQL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bbengfort.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-03T13:54:20.000Z","updated_at":"2022-07-25T03:48:02.000Z","dependencies_parsed_at":"2022-09-02T19:01:33.770Z","dependency_job_id":null,"html_url":"https://github.com/bbengfort/jobs-report","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbengfort%2Fjobs-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbengfort%2Fjobs-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbengfort%2Fjobs-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbengfort%2Fjobs-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbengfort","download_url":"https://codeload.github.com/bbengfort/jobs-report/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246933357,"owners_count":20857052,"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-10-06T17:04:01.061Z","updated_at":"2025-04-03T03:44:23.529Z","avatar_url":"https://github.com/bbengfort.png","language":"PLpgSQL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jobs Report (ELMR)\n\n[![Build Status][travis_badge]][travis_link]\n[![Coverage Status][coveralls_badge]][coveralls_link]\n[![Documentation Status][rtd_badge]][rtd_link]\n[![Stories in Ready][waffle_badge]][waffle_link]\n\n[waffle_badge]: https://badge.waffle.io/bbengfort/jobs-report.png?label=ready\u0026title=Ready\n[waffle_link]: https://waffle.io/bbengfort/jobs-report\n[travis_badge]: https://travis-ci.org/bbengfort/jobs-report.svg?branch=develop\n[travis_link]: https://travis-ci.org/bbengfort/jobs-report\n[rtd_badge]: https://readthedocs.org/projects/jobs-report/badge/?version=latest\n[rtd_link]: https://readthedocs.org/projects/jobs-report/?badge=latest\n[coveralls_badge]: https://coveralls.io/repos/bbengfort/jobs-report/badge.svg?branch=develop\n[coveralls_link]: https://coveralls.io/r/bbengfort/jobs-report\n\n[![Census punch card reader](docs/images/punch_card_reader.jpg)](https://flic.kr/p/6525aR)\n\n**Visualization of the monthly jobs report by the BLS**\n\nYou can find ELMR online as well as help documentation at the following links:\n\n- [ELMR Application](https://elmr.herokuapp.com/)\n- [ELMR Read the Docs](http://jobs-report.readthedocs.org/en/latest/)\n\nNote that pushing to the `master` branch of this repository will automatically redeploy the app to Heroku. Pushes will also update the documentation on ReadTheDocs.org.\n\n## Components\n\nThis project consists of the following:\n\n- An ingestion system that fetches data from the Bureau of Labor Statistics\n- A simple Flask application that serves data with a RESTful API\n- A front end visualization created with D3 and Bootstrap\n\n## Getting Started\n\nHere's the quick steps to get the server running so you can start developing on your local machine. Open up a terminal and run the following commands.\n\n1. Clone the repository\n\n        $ git clone git@github.com:bbengfort/jobs-report.git\n        $ cd jobs-report\n\n2. If you haven't already, it's a good idea to install virtualenv\n\n        $ pip install virtualenv\n\n    Note that you might need the `sudo` command for this.\n\n3. Create your virtualenv\n\n        $ virtualenv venv\n\n    This will make a directory called venv in your work directory.\n\n4. Activate the virtual environment\n\n        $ source venv/bin/activate\n        (venv)$\n\n    You should now see a \"venv\" in parentheses before your prompt.\n\n5. Install the dependencies into your environment\n\n        (venv)$ pip install -r requirements.txt\n\n6. Create a database for the ELMR app (ensure PostgreSQL is installed)\n\n        (venv)$ psql -c \"CREATE DATABASE elmr;\"\n        (venv)$ bin/elmr-admin.py createdb\n\n7. Migrate the to the latest version of the database\n\n        (venv)$ bin/elmr-admin.py upgrade\n\n8. Run the tests to make sure everything is set to go.\n\n        (venv)$ make test\n\n9. Run the ingestion tool to fetch the latest data.\n\n        (venv)$ bin/elmr-admin.py ingest\n\n10. Copy the ingested data to the data folder of the app (this step will be deprecated soon).\n\n        (venv)$ cp fixtures/ingest-DATE/elmr.json elmr/static/data/elmr.json\n\n11. Run the server\n\n        (venv)$ bin/elmr-admin.py runserver\n\n12. Open a browser to [http://127.0.0.1:5000/](http://127.0.0.1:5000/)\n\n## Dependencies and Development\n\nThis section describes some of the tools used in the project, as well as giving some tips and advice for quickly changing elements of the page.\n\n### Preloader Animation\n\nThe preloader animation that currently says \"Loading Visualization ...\" was created by [Preloaders.net](http://preloaders.net/en/letters_numbers_words). You can choose an animation, then customize the text, colors, animation speed, and size on their webpage. Download the gif and place it into `elmr/static/img/loader.gif` to update it if you'd like.\n\nNote: the current color matches the \"info\" text scheme, if you'd like to use it, the hexadecimal is `#31708f`.\n\n### Javascript Libraries\n\n- [moment.js](http://momentjs.com/) handles the parsing and manipulation of time\n- [moment-range](https://github.com/gf3/moment-range) handles time intervals and is crucial for the slider controller\n\n- [D3](http://d3js.org/) generates the interactive graphs and data docs.\n\n- [jQuery-UI](https://jqueryui.com/slider/#range) provides the slider control and maybe the DatePicker. I prefer to not use this library, but in the case of the slider, there isn't really too much choice. Minimize the amount this library is used!\n\n- [Underscore](http://underscorejs.org/) (`_`) and [jQuery](http://jquery.com/) (`$`) provide most of the tools and functional calls in the code.\n\n### Style Libraries\n\n- [FontAwesome](http://fortawesome.github.io/Font-Awesome/icons/) is a collection of icons. Most, if not all, of the icons are provided by font-awesome. To add an icon, enter an html tag as follows:\n\n        \u003ci class=\"fa fa-icon-class\"\u003e\u003c/i\u003e\n\n    Where \"icon class\" is the name of the icon from the list of icons at the link provided. Icons can be colored and sized using CSS font-size and color attributes.\n\n- [Bootstrap](http://getbootstrap.com/css/) handles the grid layout and most of the non-javascript components on the page. If you don't know Bootstrap, then you'll have trouble dealing with the HTML.\n\n\n## About\n\nThis project was developed as part of a course project at the University of Maryland.\n\nELMR = Economic Labor Measurement Report\n\nThe image used in this README, [Census punch card reader](https://flic.kr/p/6525aR) by [Andrew Shieh](https://www.flickr.com/photos/shandrew/), is licensed by [CC BY-NC-2.0](https://creativecommons.org/licenses/by-nc/2.0/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbengfort%2Fjobs-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbengfort%2Fjobs-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbengfort%2Fjobs-report/lists"}