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.

Getting a local preview of the Real Estate Template takes less than five minutes. The project uses pnpm as its package manager and ships a postinstall script that runs nuxt prepare automatically, so after a single install command the TypeScript types and Nuxt auto-imports are fully generated and your editor’s IntelliSense is ready to go.

​
Prerequisites

Before you begin, make sure you have the following installed on your machine:
  • Node.js 18 or later — Nuxt 4 requires Node 18+. Check with node -v.
  • pnpm — Install with npm install -g pnpm if you don’t have it. Check with pnpm -v.
  • Git — For cloning the repository.

​
Setup

1
Clone the repository
2
Clone the template to your local machine and move into the project directory.
3
git clone https://github.com/Ozcaar/real-estate-template.git my-agency-site
cd my-agency-site
4
Install dependencies
5
Install all dependencies with pnpm. The postinstall hook runs nuxt prepare automatically, so you do not need to run it separately.
6
pnpm install
7
nuxt prepare generates the .nuxt/ directory, which contains TypeScript type declarations for auto-imported composables, components, and Nuxt’s runtime internals. Your IDE will not have accurate IntelliSense until this step completes.
8
Start the development server
9
Start the Nuxt development server. It will be available at http://localhost:3000.
10
pnpm dev
11
Open your browser and navigate to http://localhost:3000. You should see the landing page with the default agency branding — “Real Estate Agency” — and sample property, development, and agent data already populated.
12
Customize for your agency
13
All agency-specific settings live in a single file: app/config/agencies/default.agency.ts. Open it and replace the placeholder values with your agency’s real information. No component editing is required.
14
// app/config/agencies/default.agency.ts
import type { AgencyConfig } from '~/types/agency.types'

export const defaultAgencyConfig: AgencyConfig = {
  id: 'default',
  name: 'Real Estate Agency',
  slogan: 'Find your ideal property',
  logo: '/images/logo.svg',
  favicon: '/favicon.ico',

  // Reference a theme by ID — must match a file in app/themes/
  theme: 'default',

  defaultLocale: 'en',
  availableLocales: ['en', 'es'],

  currency: 'USD',
  measurementUnit: 'metric',

  contact: {
    phone: '1-800-555-1234',
    whatsapp: '1-800-555-1234',
    email: 'example@email.com',
    address: '123 Main Street, Anytown, USA',
    businessHours: 'Mon-Fri 9am-5pm',
  },

  social: {
    facebook: 'http://www.facebook.com/youragency',
    instagram: 'http://www.instagram.com/youragency',
    linkedin: 'http://www.linkedin.com/youragency',
    tiktok: 'http://www.tiktok.com/youragency',
    youtube: 'http://www.youtube.com/youragency',
  },

  // Toggle entire site sections on/off — no component edits needed
  modules: {
    properties: true,
    developments: true,
    agents: true,
    blog: false,
    testimonials: true,
    contact: true,
  },
}
15
To rebrand the site for a different agency without losing the default config, create a new file (e.g., app/config/agencies/acme.agency.ts), copy the shape above, fill in the new values, and update the import in app/config/site.config.ts to point at the new file. The active agency is resolved from that single import — no other file needs to change.
16
Configure the site URL (for production SEO)
17
The template reads the base URL for canonical links, Open Graph URLs, and absolute sitemap entries from an environment variable. Create a .env file at the project root:
18
NUXT_PUBLIC_SITE_URL=https://youragency.com
19
This variable is optional for local development — the app builds and runs without it — but it must be set before a production deployment to ensure correct SEO metadata.

​
Building for Production

The template supports both server-side rendering and full static export.
Run a standard Nuxt production build. This outputs a Node.js server bundle to .output/server/.
pnpm build
Preview the built output locally with:
pnpm preview

​
Available Scripts

Every script in package.json is listed below for reference.
ScriptCommandDescription
devnuxt devStart the hot-reloading development server on localhost:3000
buildnuxt buildCompile a production server-side rendering bundle
generatenuxt generatePre-render the full site as static HTML
previewnuxt previewServe the production build locally for final checks
linteslint .Run ESLint across the whole project
lint:fixeslint . --fixRun ESLint and auto-fix all fixable violations

Project Structure

Learn where everything lives — features, config, themes, i18n, and server routes.

Introduction

Read the full overview of the template’s architecture and feature set.

Build docs developers (and LLMs) love

Get started for freeTalk to us