Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Ozcaar/real-estate-template/llms.txt

Use this file to discover all available pages before exploring further.

Real Estate Template is a production-ready Nuxt 4 starter for building white-label real estate websites. It ships with a property catalog, agent directory, development portfolio, internationalization, and a CSS-variable-based theme system — all driven by a single agency configuration file. Change your agency’s name, logo, colors, and contact details in one place and every component updates automatically.

Quickstart

Install dependencies and run your first local preview in under five minutes.

Agency Config

Swap the agency identity, currency, and enabled modules without touching components.

Theming

Create custom themes using design tokens that compile to CSS variables at runtime.

Data & Content

Replace the sample properties, agents, and developments with real agency data.

Architecture

Understand the feature-first folder layout and module ownership model.

Component Reference

Explore the Base* UI primitives, App* layout shells, and feature components.

What’s included

The template covers the full public surface of a real estate website out of the box:

Property Catalog

Filterable listing page with accent-insensitive search and stable sort orders.

Property Detail

Slug-based detail pages with gallery, amenities, and related listings.

Developments

Portfolio of residential developments with status badges and price ranges.

Agent Directory

Team page with WhatsApp, email, and specialty tags per agent.

i18n Built-in

English and Spanish out of the box via @nuxtjs/i18n — add more locales anytime.

SEO & Structured Data

Automatic JSON-LD, sitemap.xml, robots.txt, and Open Graph tags per page.

Tech stack

The template is built on a modern, well-supported stack with no experimental dependencies:
LayerTechnology
FrameworkNuxt 4 (app/ directory convention)
UIVue 3 + TypeScript
StylingTailwind CSS v4 via @tailwindcss/vite
StatePinia
ValidationZod v4
i18n@nuxtjs/i18n (English + Spanish)
Images@nuxt/image + Nuxt Icon
UtilitiesVueUse, Swiper

Getting started

1

Clone and install

Clone the repository and install dependencies with pnpm.
git clone https://github.com/Ozcaar/real-estate-template.git
cd real-estate-template
pnpm install
2

Start the dev server

pnpm dev
Open http://localhost:3000 to see the template running with sample data.
3

Configure your agency

Edit app/config/agencies/default.agency.ts to set your agency name, logo, contact details, and which modules are enabled. See the Agency Config guide for the full field reference.
4

Replace sample data and build

Swap the placeholder properties, agents, and developments with your real data files, then run pnpm build for production.
The postinstall script runs nuxt prepare automatically, so TypeScript types and auto-imports are ready immediately after pnpm install.

Build docs developers (and LLMs) love