Housr-Webapp

Housr-Webapp is a Next.js marketing website and property search platform for student housing across the US and UK. It serves as the public-facing website at housr.com with locale-based routing (/en-us/* for the US, /en-gb/* for the UK).

Tech Stack

Framework: Next.js (App Router, Turbopack)
Language: TypeScript 5
Styling: Tailwind CSS 4 + Shadcn/UI (New York style)
Database: MySQL via mysql2/promise (direct queries for search)
CMS: Contentstack (blog posts, location content)
Maps: Mapbox GL
Payments: Finix (perk partner subscriptions)
Animations: Motion (Framer Motion)

Development Commands


npm run dev          # Start dev server (Turbopack) at localhost:3000
npm run build        # Production build
npm run lint         # ESLint (next/core-web-vitals + next/typescript)
npm run type-check   # TypeScript check (tsc --noEmit)
npm run format       # Prettier format all files

No test framework is configured in this project.

Documentation

Setup Guide — Local development prerequisites and environment variables
Architecture — App Router structure, locale system, routing
Data Layer — REST API helpers, direct MySQL, server actions, caching
Layouts — Route config, SmartHeaderLayout, navigation, header assembly
i18n — Dictionary system, locale detection, region-specific content
Conventions — Code style, path aliases, utilities, icons, fonts
Deployment — Build process and hosting

Feature Docs

Search — Property search with direct MySQL queries
Bills — Multi-step bills checkout flow
Perk Partners — Finix payments and partner onboarding
Property — Property detail pages and UK rental routes
Enquiry — Property enquiry forms
CMS — Contentstack blog, location content