An ambitious web app for filtering and viewing NYC land use application records stored in DCP's Zoning Application Portal (ZAP).
In order for cookies to work across both the client and the server during local development, we must have SSL setup for our development environment.
Google Chrome is beginning to enforce some restrictions on particular uses of cookies in cross-origin contexts. In our case, our server provides a cookie from one domain and is expected to be sent across subsequent requests via another. The only way to simulate this behavior as it works on a production environment is to run our local development servers with SSL enabled.
Clone this repo and follow the steps in its README: https://github.com/NYCPlanning/local-cert-generator
Note that Step 1 generates two files in the local-cert-generator
repo: server.key
and server.crt
. Later, you will need to copy/paste these files into the labs-zap-search
repo to run the application (Steps 2 and 3 under "Running the App").
Open up your hosts file on your machine with admin permissions: /etc/hosts
. For example, sudo vim /etc/hosts
Add the following line: 127.0.0.1 local.planninglabs.nyc
Once you have SSL enabled...
labs-zap-search
to your computer.server
folder.
development.env
file using variables stored on 1Password.server.key
and server.crt
files from your local-cert-generator
repo and paste both files into the labs-zap-search/server/ssl/
folder.nvm use
yarn
to install dependencies for the server.yarn run start:dev
to start a development serverclient
folder.
server.key
and server.crt
files from your local-cert-generator
repo and paste both files into the labs-zap-search/client/ssl/
folder.nvm use
yarn
to install dependencies for the client.yarn start:ssl
to start a development serverThe client and server application node versions have become out of sync with each other. Consequently, the pre-commit hooks have been turned off until both the server and client are on the same node version.
Husky is designed to use the node version set in the terminal PATH at the time the command is run. Whichever node version the developer chooses will be the one that the both the client and server are tested against. This can lead to weird cases where the client or server passes in the environment it's developed for but fails in the environment where its tests are run.
As the hooks have been disabled, please take care to run linting and testing scripts for the server and client before committing. These scripts are documented in their respective package.json
files.
To enable "maintenance mode", set two environment variables in the frontend (Netlify) build environment:
MAINTENANCE_START='06/28/2021 19:00' MAINTENANCE_END='06/29/2021 19:00'
Use the date format in the example above. This will warn of upcoming maintenance (if the start date is in the future), disable the login, and disappear once the end period has passed.