- 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
- Create
.env.local
and set the required environment variables.- Local development credentials are available within the NYC planning password vault under "EDDE Credentials"
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.
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
This project was originally bootstrapped via create-next-app
using the with-chakra-ui-typescript
preset
Additional project boilerplate and configuration was drawn from: