README.md

Am I Rent Stabilized?

A mobile friendly, multi-lingual web app that informs NYC residents about Rent Stabilization by simplifying the process of how to find out if their apartment may be rent stabilized, if they are paying too much rent, and what to do about it.

Data Sources

Installation

Make sure you have Node.js at v5.9.1 or greater with Node-Sass, Handlebars, and Gulp modules installed globally.

In terminal cd to this repo and do npm install to grab all dependencies.

Run gulp production to compile the distribution code.

Host code on a webserver of your choice.

Develop

Make sure you have Node.js at v5.9.1 or greater with Node-Sass, Handlebars, and Gulp modules installed globally.

Run gulp to start a local server and automatically watch for changes. The site will refresh automatically after making any changes.

Run gulp production to compile the distribution code in a build/ directory.

Updating the Site's Content:

As the entire site is translated to Chinese and Spanish, any changes to the site's content must also be translated to these languages. This is done by editing the JSON files in app/data/.

Any changes to the site's HTML must be made to the Handlebars templates in app/templates/.

Each of the JSON files and Handlebars files in these folders corresponds to one page of the app (index.html, why-it-matters.html, how-it-works.html, & resources.html). Each JSON file contains the written content in 3 languages while each template file contains the markup and Handlebars templating code.

After updating these sets of files you must precompile the templates for the content to be updated in the app. You can run the gulp templates task to do this by running the following npm script:

npm run compile-templates

If you're running the gulp default task, then making changes to any files in app/templates/*.hbs will automatically re-compile app/js/templates.js. However, you will still need to compile the bundled files for the app, bundle.js and otherpages.js, otherwise the app will not use the newly compiled templates!

John Krauss provided data for NYC properties that should have rent-stabilized apartments due to receiving tax exemptions from state programs such as 421a. (You can learn more on the the repo for nyc-stabilization-unit-counts).