New York City Census Reporting Tool
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci add netlify config, modify circleci config Jan 18, 2019
app handle block -> puma transition Feb 20, 2019
bin Hotfix bin/develop, add gittower line Feb 21, 2019
config Minimal bump test cov Feb 19, 2019
ember-clean-project 696 Add HR before computers section Feb 20, 2019
public set null Rikers thematic maps values to 0 to prevent styling them black Feb 19, 2019
tests Scope test to correct div Feb 21, 2019
vendor Initial Ember structure Oct 24, 2017
.editorconfig Initial Ember structure Oct 24, 2017
.ember-cli Initial Ember structure Oct 24, 2017
.eslintignore Upgrad ember-source; resolve conflicts Dec 6, 2018
.eslintrc.js Upgrad ember-source; resolve conflicts Dec 6, 2018
.gitignore Initial Ember structure Oct 24, 2017
.netlifyredirects add netlify config, modify circleci config Jan 18, 2019
.template-lintrc.js Upgrad ember-source; resolve conflicts Dec 6, 2018
.watchmanconfig Initial Ember structure Oct 24, 2017
CONTRIBUTING.md update README, add license and contributing Dec 29, 2017
ISSUE_TEMPLATE.md 689 Update references to old year Feb 19, 2019
LICENSE.md update README, add license and contributing Dec 29, 2017
MODULE_REPORT.md Remove unused tests Mar 5, 2018
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Dec 14, 2017
README.md Update README Feb 21, 2019
ember-cli-build.js subset used fa-icons in environment.js, fix refs to fa-icon names fro… Dec 13, 2018
latest-change-view.png Update env files for more screenshots Mar 6, 2018
latest-current-view.png HOTFIX: Ember scroll-to bug Mar 8, 2018
netlify.toml add netlify config, modify circleci config Jan 18, 2019
package.json 700 install percy Feb 21, 2019
testem.js Revert "Update timeout" Dec 13, 2018
yarn.lock 700 install percy Feb 21, 2019

README.md

CircleCI

NYC Population FactFinder

Population FactFinder allows you to easily define study areas — by selecting Census Tracts, Census Blocks, Neighborhood Tabulation Areas (NTAs), or Public Use Microdata Areas (PUMAs) — and produce detailed population profiles.

pff

How we work

NYC Planning Labs takes on a single project at a time, working closely with our customers from concept to delivery in a matter of weeks. We conduct regular maintenance between larger projects.

Take a look at our sprint planning board to get an idea of our current priorities for this project.

How you can help

In the spirit of free software, everyone is encouraged to help improve this project. Here are some ways you can contribute.

  • Comment on or clarify issues
  • Report bugs
  • Suggest new features
  • Write or edit documentation
  • Write code (no patch is too small)
    • Fix typos
    • Add comments
    • Clean up code
    • Add new features

Read more about contributing.

Requirements

You will need the following things properly installed on your computer.

Local development

  • Clone this repo https://github.com/NYCPlanning/labs-nyc-factfinder.git
  • Install Dependencies npm install
  • Start the server ember s

Development shortcut

  • Run bin/develop
  • This should open the correct servers and editors, assuming you also have labs-factfinder-api cloned and configured

Architecture

Primary views:

  • Selection view - Allows the user to create a selection of geometries to view census/ACS data about.
  • Profile view(s) - Shows census/ACS data tables and charts for the selected geometries.

The profile route contains 4 different ACS profiles (Demographic, Social, Economic, Housing) and the Decennial Census Profile. Each fetches data independently when loaded.

Backend services

  • Carto - A carto instance serves as the primary datastore for census and ACS data, and a map tiler
  • factfinder-api - An express api that handles search AND maps collections of selected geoids to an integer. Useful for persisting selections across browser sessions (also makes reports shareable)

Testing and checks

  • ESLint - We use ESLint with Airbnb's rules for JavaScript projects

    • Add an ESLint plugin to your text editor to highlight broken rules while you code
    • You can also run eslint at the command line with the --fix flag to automatically fix some errors.
  • Testing

    • run ember test --serve
    • Before creating a Pull Request, make sure your branch is updated with the latest develop and passes all tests

Deployment

Deployment happens automatically via circleci when master is updated.

To deploy manually: Create dokku remote: git remote add dokku dokku@{dokkudomain}:factfinder Deploy: git push dokku master

Contact us

You can find us on Twitter at @nycplanninglabs, or comment on issues and we'll follow up as soon as we can. If you'd like to send an email, use labs_dl@planning.nyc.gov