# Bloom Housing

## Docs

- [Authentication](https://mintlify.wiki/bloom-housing/bloom/api/authentication.md): How to authenticate with the Bloom Housing API using JWT tokens and cookies.
- [Authorization](https://mintlify.wiki/bloom-housing/bloom/api/authorization.md): Role-based and attribute-based access control for the Bloom Housing API.
- [API Overview](https://mintlify.wiki/bloom-housing/bloom/api/overview.md): A REST API built with NestJS that powers the Bloom Housing platform. Manage listings, applications, users, and more.
- [Architecture](https://mintlify.wiki/bloom-housing/bloom/architecture.md): A technical overview of Bloom's monorepo structure, package responsibilities, backend design, and testing strategy.
- [Database](https://mintlify.wiki/bloom-housing/bloom/configuration/database.md): Set up and manage the PostgreSQL database for the Bloom Housing API using Prisma.
- [Environment Variables](https://mintlify.wiki/bloom-housing/bloom/configuration/environment-variables.md): Configure the Bloom Housing platform using environment variables for the API, Public Site, and Partners Site.
- [Feature Flags](https://mintlify.wiki/bloom-housing/bloom/configuration/feature-flags.md): Per-jurisdiction boolean flags that enable or disable platform features in Bloom Housing.
- [Contributing Guidelines](https://mintlify.wiki/bloom-housing/bloom/contributing/guidelines.md): How to contribute to Bloom Housing — issue tracking, commit conventions, code style, and pull request process.
- [Testing](https://mintlify.wiki/bloom-housing/bloom/contributing/testing.md): Testing strategy for Bloom Housing — backend unit and integration tests, frontend Cypress and Jest tests, and how to run them all.
- [CI/CD](https://mintlify.wiki/bloom-housing/bloom/deployment/ci-cd.md): GitHub Actions workflows for continuous integration, secret scanning, dependency management, and Docker image publishing.
- [Docker](https://mintlify.wiki/bloom-housing/bloom/deployment/docker.md): Run Bloom Housing with Docker Compose to emulate a cloud deployment locally on your machine.
- [Infrastructure](https://mintlify.wiki/bloom-housing/bloom/deployment/infrastructure.md): Deploy Bloom Housing to production using OpenTofu infrastructure-as-code on AWS, with Netlify for frontend sites.
- [Applications](https://mintlify.wiki/bloom-housing/bloom/features/applications.md): Understand the application workflow, from submission through review, export, and data expiry.
- [Jurisdictions](https://mintlify.wiki/bloom-housing/bloom/features/jurisdictions.md): Configure and manage jurisdictions — the top-level multi-tenancy unit in Bloom Housing.
- [Listings](https://mintlify.wiki/bloom-housing/bloom/features/listings.md): Create and manage affordable housing listings, from draft through publication and closure.
- [Lottery](https://mintlify.wiki/bloom-housing/bloom/features/lottery.md): Run, manage, and publish lottery results for oversubscribed affordable housing listings.
- [Introduction](https://mintlify.wiki/bloom-housing/bloom/introduction.md): Bloom is an open-source affordable housing platform by Exygy that connects housing seekers with listings and gives housing partners the tools to manage applications and lotteries.
- [Quick Start](https://mintlify.wiki/bloom-housing/bloom/quickstart.md): Get the full Bloom stack — API, Public portal, and Partners portal — running on your local machine.
- [Partners Portal](https://mintlify.wiki/bloom-housing/bloom/sites/partners-portal.md): The administrative Next.js dashboard for housing developers, property managers, and city/county staff to manage listings, applications, lotteries, and users.
- [Public Portal](https://mintlify.wiki/bloom-housing/bloom/sites/public-portal.md): The applicant-facing Next.js site where housing seekers browse listings, submit applications, and manage their accounts.

## OpenAPI Specs

- [openapi](https://mintlify.wiki/bloom-housing/bloom/api-reference/openapi.json)