Skip to content

0xStarcat/nyc_building_monitor_api

Repository files navigation

NYC Building Monitor

Description

The NYC Building monitor is a tool that NYC tenants can use to help them make informed housing decisions and fight for housing justice.

Setup

  1. Clone this repo and the frontend repo into separate directories.
  2. Install node packages npm install
  3. This project requires python 3.5.2+. Check your python version with python3 --version and upgrade if needed.
  4. Create a virtual env if desired inside the python_scripts directory with python3 -m venv venv and activate with source venv/bin/activate
  5. Pip install the required python packages with pip install -r requirements.txt
  6. Download the raw data from dropbox ( link ) and place the data directory into the project root.
  7. Create a sqlite3 database file at root named nyc_data_map.sqlite
  8. Create the database tables with alembic - alembic upgrade head
  9. Seed the database tables with python3 prepare.py (may take about an hour)
  10. Seed the rest of the data from the NYC open data portal API with python3 update.py (may take a couple hours)
  11. Start the backend server with npm run-script nodemon
  12. Start the frontend client with npm run-script dev and visit localhost:3000

API

  1. Server can started for development with npm run-script nodemon, for production with npm start in a production environment with PM2 installed.
  2. Tests run with npm test

Sources

Boroughs (clipped to shoreline) http://services5.arcgis.com/GfwWNkhOj9bNBqoJ/arcgis/rest/services/nybb/FeatureServer/0/query?where=1=1&outFields=*&outSR=4326&f=geojson

Neighborhoods http://data.beta.nyc/dataset/pediacities-nyc-neighborhoods/resource/35dd04fb-81b3-479b-a074-a27a37888ce7

Census tracts 2010 (clipped to shoreline) https://www1.nyc.gov/site/planning/data-maps/open-data/districts-download-metadata.page NOTE - needs to be converted from .shp to .geojson since the api only delivers 2000 (full number is 2166) https://services5.arcgis.com/GfwWNkhOj9bNBqoJ/arcgis/rest/services/nyct2010/FeatureServer/0/query?where=1=1&outFields=*&outSR=4326&f=geojson

Income http://app.coredata.nyc/?mlb=false&ntii=hh_inc_med_adj&ntr=Census%20Tract&mz=14&vtl=https%3A%2F%2Fthefurmancenter.carto.com%2Fu%2Fnyufc%2Fapi%2Fv2%2Fviz%2F691a2b7c-94d7-46ac-ac4d-9a589cb2c6ed%2Fviz.json&mln=true&mlp=true&mlat=40.718&ptsb=&nty=2012-2016&mb=roadmap&pf=%7B%22subsidies%22%3Atrue%7D&md=table&mlv=false&mlng=-73.996&btl=Borough&atp=neighborhoods

Rent http://app.coredata.nyc/?mlb=false&ntii=rent_gross_med_adj&ntr=Census%20Tract&mz=14&vtl=https%3A%2F%2Fthefurmancenter.carto.com%2Fu%2Fnyufc%2Fapi%2Fv2%2Fviz%2F691a2b7c-94d7-46ac-ac4d-9a589cb2c6ed%2Fviz.json&mln=true&mlp=true&mlat=40.718&ptsb=&nty=2012-2016&mb=roadmap&pf=%7B%22subsidies%22%3Atrue%7D&md=table&mlv=false&mlng=-73.996&btl=Borough&atp=neighborhoods

Race https://www1.nyc.gov/site/planning/data-maps/nyc-population/census-2010.page

About

The backend API and database manager for the NYC Building Monitor

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published