Installation

Installation Guide

This guide is for contributors setting up RentifyNow locally. To use the product without a development checkout, open the web app or try the landlord demo.

Prerequisites

Use Node.js 22 or later, pnpm 9.15.4, the .NET 10 SDK, Docker with Compose, and Git. The repository manifests and local setup guide are authoritative when requirements change.

From your authorized RentifyNow checkout, verify the tools:

node --version
pnpm --version
 dotnet --version
 docker compose version

Install workspace dependencies

Run these commands from the repository root:

pnpm install --frozen-lockfile
pnpm local:check

The workspace includes the Angular frontend and shared packages. The TypeScript authentication service has its own dependency manifest. Follow the repository's local setup guide for the complete service environment rather than copying environment files or credentials from another checkout.

Start an isolated local stack

The maintained local helper prepares the project configuration and starts the service dependencies:

./scripts/local-dev.sh setup
./scripts/local-dev.sh up
./scripts/local-dev.sh status

The stack uses PostgreSQL, RabbitMQ, Valkey, S3-compatible storage, the authentication service, and the domain APIs. Migrations and synthetic seed data follow the local stack lifecycle. It does not use SQL Server or Azure emulators.

Keep generated local configuration private. Do not commit credentials, reuse production data, or reset another contributor's stack. Multiple checkouts need isolated ports and task-owned resources; consult docs/02-development/local-setup.md before starting services.

Aspire and frontend development

The repository also supports Aspire. Start the AppHost through the port-isolation wrapper:

node scripts/port-isolation.mjs run -- dotnet run --project src/app/RentifyNow.AppHost

For frontend development against the selected local backend, run:

pnpm dev:web

Use the URLs reported by the port wrapper or Aspire dashboard. Do not assume copied service ports are available, and do not start competing orchestration stacks against the same resources.

Verify your changes

Choose focused tests for the changed feature before widening to maintained checks:

pnpm type-check
pnpm lint
pnpm --dir apps/web run i18n:validate
pnpm --dir apps/web build

Backend changes also need the affected service tests and solution build. The repository's agent handbook and quality-gate documentation describe the required checks. A successful local build does not prove deployment, live integrations, or production readiness.

Next steps

For local failures, inspect the task's service health and sanitized logs before changing configuration. Report reproducible issues through the repository's established contribution process; there is no verified public community forum linked from this guide.