Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.13 KB

README.md

File metadata and controls

41 lines (30 loc) · 1.13 KB

Equity Explorer (AKA Equitable Development Data Explorer)

Setup

  1. Install project node version listed in .nvmrc
git  clone [email protected]:NYCPlanning/equity-tool.git
cd equity-tool
npm i

This command should install all necessary dependencies and set up Husky to run on all commits

  1. Create .env.local and set the required environment variables.
    • Local development credentials are available within the NYC planning password vault under "EDDE Credentials"

Running locally

To run the Nextjs dev server, run:

npm run dev

You can also run unit tests or the linter by running npm run test or npm run lint, respectively.

Tests

Run the suite of Jest tests under /test

npm run test

The data powering this app is generated by this ETL workflow: https://github.com/NYCPlanning/ose-equity-tool-etl

Attribution

This project was originally bootstrapped via create-next-app using the with-chakra-ui-typescript preset

Additional project boilerplate and configuration was drawn from: