Eviction Free NYC!

This site was built in conjunction with the Right to Counsel Coalition as a new resource for NYC tenants to navigate the new RTC law, learn how to respond to an eviction notice, and access legal aid services.

This site is built on top of GatsbyJS.

Getting the site up-and-running

Before installing anything, you will want to check out the repository and create an .env.development file from the template:

cp .env.development.sample .env.development

Now edit .env.development as needed.

You can now develop using either the local installation of node on your computer, or via Docker.

Option 1: Developing with your local installation of node

Make sure that you have node >= v10 and yarn >= 1.17 running. In a terminal window, type node --version and hit ENTER, then yarn --version and hit ENTER to get this info.

Once your environment is setup, you'll need to download libraries (make sure you're in the root directory):

yarn install

Then run the following to start your dev environment!

yarn netlify:develop

You should be able to access your development server at http://localhost:8001/.

Option 2: Developing with Docker

Get Docker and run:

docker-compose run app yarn
docker-compose up

Then visit http://localhost:8001/ in your browser and you should be good to go.

Deploying

See the deploy instructions on the GatsbyJS site to decide what's best for you!

Serverless functionality

The files in src/serverless-functions are accessible as Netlify Functions, both during development and in production. For instance, this means that a file at src/serverless-functions/foo.ts can be accessed at /.netlify/functions/foo.

Textbot

A EFNYC textbot based off textit-webhook-fun is in the src/textbot directory. It can be run in the terminal with:

node run-textbot.js

For production, it's exposed via a serverless function at /.netlify/functions/textbot. Because we currently use RapidPro/TextIt as our primary SMS gateway, the RapidPro flow in src/textbot/sample-rapidpro-textbot-flow.json needs to be imported in order to interface with it.

Attribution

The starter for this site was gatsby-contentful-i18n, built by mccrodp! Many thanks!

Also a huge thanks to the team at Contentful for their generous support.

We use BrowserStack Live to make sure that our sites work across browsers, operating systems, and devices.

License

JustFix.nyc uses the GNU General Public License v3.0 Open-Source License. See LICENSE.md file for the full text.

Code of Conduct

Read about JustFix's code of conduct as an organization on our Mission page, as well as on the Right to Counsel's About page