Quick Start
Set up the full Bloom stack locally in minutes — backend API, public portal, and partners portal.
Architecture
Understand how the API, public site, partners site, and shared helpers fit together.
Listings
Create, publish, and manage affordable housing listings with rich unit and eligibility data.
Applications
Accept and manage housing applications through the Common Application workflow.
What Bloom provides
Public Portal
A Next.js applicant-facing site for browsing listings and submitting housing applications.
Partners Portal
An administrative dashboard for housing developers, property managers, and city staff.
Lottery System
Run randomized lotteries for oversubscribed listings with automated applicant ranking.
Jurisdictions
Multi-tenant support with per-jurisdiction feature flags, translations, and configuration.
Explore the platform
Start the full stack locally
Install dependencies and run the backend, public site, and partners portal simultaneously with
yarn dev:all.Browse and configure listings
Use the Partners Portal to create listings with unit types, eligibility requirements, and application methods.
Accept applications
Housing seekers apply through the Public Portal using the Common Application. Applications are stored and managed via the REST API.
API & configuration
API Overview
Explore the REST API endpoints for listings, applications, users, and more.
Authentication
Learn how to authenticate with JWT tokens and MFA.
Feature Flags
Configure per-jurisdiction feature flags to customize the platform’s behavior.
Environment Variables
Reference all environment variables needed to run the API and frontend sites.