afv-library/samples/ui-bundle-template-app-react-sample-b2e
2026-03-30 09:52:18 -07:00
..
.husky chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
config chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
force-app/main/default chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
scripts chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
.forceignore chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
.prettierignore chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
.prettierrc chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
.version chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
AGENT.md chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
CHANGELOG.md chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
eslint.config.js chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
jest.config.js chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
LICENSE.txt chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
package-lock.json chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
package.json chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
README.md chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00
sfdx-project.json chore: rename sample folders to match ui-bundle-template package names 2026-03-30 09:52:18 -07:00

Property Management App

A property management sample React UI Bundle for the Salesforce platform. Demonstrates property management, maintenance requests, tenant applications, a dashboard, and an Agentforce conversation client. Built with React, Vite, TypeScript, and Tailwind/shadcn.

What's included

Path Description
force-app/main/default/uiBundles/propertymanagementapp/ React UI Bundle (source, config, tests)
force-app/main/default/objects/ 17 custom objects — Agent__c, Application__c, KPI_Snapshot__c, Lease__c, Maintenance_Request__c, Maintenance_Worker__c, Notification__c, Payment__c, Property__c, Property_Cost__c, Property_Feature__c, Property_Image__c, Property_Listing__c, Property_Management_Company__c, Property_Owner__c, Property_Sale__c, Tenant__c
force-app/main/default/layouts/ Page layouts for each custom object
force-app/main/default/permissionsets/ Property_Management_Access permission set
force-app/main/default/data/ Sample data (JSON) for all objects, importable via sf data import tree

Getting started

Navigate to the UI Bundle and install dependencies:

cd force-app/main/default/uiBundles/propertymanagementapp
npm install
npm run dev

Opens at http://localhost:5173 by default. For build and test instructions, see the UI Bundle README.

Deploy

Deploy everything (metadata + UI Bundle)

cd force-app/main/default/uiBundles/propertymanagementapp && npm install && npm run build && cd -
sf project deploy start --source-dir force-app --target-org <alias>

Deploy the UI Bundle only

cd force-app/main/default/uiBundles/propertymanagementapp && npm install && npm run build && cd -
sf project deploy start --source-dir force-app/main/default/ui-bundles --target-org <alias>

Deploy metadata only (objects, layouts, permission sets)

sf project deploy start \
  --source-dir force-app/main/default/objects \
  --source-dir force-app/main/default/layouts \
  --source-dir force-app/main/default/permissionsets \
  --target-org <alias>

Replace <alias> with your target org alias.

Assign permset

After deploying the metadata, assign the Property_Management_Access permission set to your user to grant access to the custom objects and fields:

sf org assign permset -n Property_Management_Access --target-org <alias>

Replace <alias> with your target org alias.

Import sample data

sf data import tree --plan force-app/main/default/data/data-plan.json --target-org <alias>

Using setup-cli.mjs

When this app is built (e.g. from the monorepo or from a published package), a setup-cli.mjs script is included at the project root. It runs the full setup in one go: login (if needed), deploy metadata, assign the Property_Management_Access permission set, prepare and import sample data, fetch GraphQL schema and run codegen, build the UI Bundle, and optionally start the dev server.

Run from the project root (the directory that contains force-app/, sfdx-project.json, and setup-cli.mjs):

node setup-cli.mjs --target-org <alias>

Common options:

Option Description
--skip-login Skip browser login (org already authenticated)
--skip-data Skip data preparation and import
--skip-graphql Skip GraphQL schema fetch and codegen
--skip-ui-bundle-build Skip npm install and UI Bundle build
--skip-dev Do not start the dev server at the end
--permset <name> Permission set to assign (default: Property_Management_Access)
--app <name> Web app folder name when multiple exist

For all options: node setup-cli.mjs --help.

Configure Your Salesforce DX Project

The sfdx-project.json file contains useful configuration information for your project. See Salesforce DX Project Configuration in the Salesforce DX Developer Guide for details about this file.

Read All About It