This is the reference implementation of our partners web app, providing the UI for all of the administrative functions for affordable housing partners including managing applications and listings. Partners include housing developers, property managers, cities, and counties. You can read more about the product at bloomhousing.com.
The following commands are for macOS / Linux, but you can find equivalent instructions for Windows machines online.
If you don't have yarn installed, you can install homebrew with these instructions and then do so with brew install yarn
.
yarn install
at root to install dependencies- From within
sites/partners
copy the.env.template
to.env
and edit variables appropriate to your local environment - some keys are secret and are internally available - the template file includes default values and descriptions of each variable yarn dev:all
at root will start up the backend at port 3100 and the partners app at port 3001
For our partners application, our tests currently consist of both a Cypress end to end suite and a jest unit/integration suite.
To run the Cypress suite, with the application already running, run yarn test
from within sites/partners
.
To run the unit/integration suite, run yarn test:unit
from within sites/partners
, or yarn test:unit:coverage
to run with coverage reports.