Housr Tech Docs
Welcome to the Housr engineering documentation. This site is the central reference for all Housr technical systems, architecture decisions, and developer conventions.
Core Repositories
| Repo | Stack | Purpose |
|---|---|---|
| Housr-Webapp | Next.js 15, Tailwind 4, Shadcn/UI | Marketing website, property search (US + UK) |
| Housr-App | Expo (React Native), React Query v5 | Mobile app for students (US + UK) |
| Housr-API | Laravel (PHP) | Legacy API (v1) — being phased out |
| Housr-API2 | Laravel Modules (PHP) | Current API (v2) — all new work goes here |
| Housr Portal | Laravel + Filament 4 | Internal admin tool for ops, agents, landlords |
Supporting Repositories
| Repo | Purpose |
|---|---|
| Housr-Property-Feeds | Imports property data from Entrata (US), Jupix/BLM (UK) into the shared database |
| Housr-AI | AI/ML projects |
| Housr-Brand-Portal | Brand assets and guidelines |
| Housr Bills | Bills management system |
How These Docs Work
Each core repo maintains its own docs/ folder as the source of truth for that system. This site aggregates them into a single browsable reference.
- Repo-specific docs (Webapp, App, API v1, API v2, Portal) are synced from each repo’s
docs/directory usingnpm run sync-docs - Cross-cutting docs cover topics that span multiple repos: auth, database schema, API versioning, regional logic, third-party services
- Conventions document shared engineering standards across the team
Quick Links
- Getting Started — Onboarding guide for new engineers
- Architecture Overview — How all the systems connect
- Cross-Cutting Concerns — Auth, DB schema, API versioning, regional logic
- Conventions — Code style, git workflow, adding features
Last updated on