Back to tutorials

AnchorLaunch the Invest Immo demo app locally

This tutorial walks you through the open-source demo project immoteur/demo-invest-immo. You will run the Next.js app locally, connect it to the Immoteur API with a personal access token, and browse DPE F/G apartment listings in minutes.

If you want to preview the experience first, open the live demo: https://demo-invest-immo.immoteur.com.

Tip: the token is shown only once after creation. Store it in a password manager before closing the modal.

AnchorWhat you'll build

  • A local Next.js demo app that keeps the Immoteur token server-side.
  • A simple UI with a single-select department filter and result cards.
  • A configurable feed you can tune via .env.

AnchorPrerequisites

  • An Immoteur account with API access.
  • Node.js 20+ and pnpm.
  • Git (and Docker if you want to use the container setup).

AnchorArchitecture diagram

Rendering diagram...

AnchorStep-by-step guide

Anchor1) Create an Immoteur API token

  1. Sign in at https://immoteur.com
  2. Open the tokens page: https://immoteur.com/dashboard/tokens
  3. Click Create token, name it (for example invest-immo-demo), and copy it
Token creation screen (placeholder)

Anchor2) Clone the demo project

git clone https://github.com/immoteur/demo-invest-immo.git
cd demo-invest-immo
pnpm install
cp .env.example .env

Anchor3) Set your .env values

Open .env and add your API token:

IMMOTEUR_API_KEY=immoteur_xxx
 
# Optional defaults
IMMOTEUR_TRANSACTION_TYPE=sale
IMMOTEUR_PROPERTY_TYPES=apartment
IMMOTEUR_DPE_LABELS=F,G
IMMOTEUR_MAX_RESULTS=15

Anchor4) Start the app

Anchor5) Explore and tune the feed

Try the department filter, then adjust the feed by editing .env:

  • IMMOTEUR_DPE_LABELS to broaden or narrow the energy labels
  • IMMOTEUR_PROPERTY_TYPES to switch from apartments to other property types
  • IMMOTEUR_MAX_RESULTS to cap the number of cards

Restart the dev server after changing .env values.

AnchorConclusion

You now have the Invest Immo demo running locally with your own Immoteur API token. Next, try swapping the filters or deploying the demo to a private preview environment.

Launch the Invest Immo demo app locally | Immoteur