Terrace

Terrace documentation

Getting started#

On this page

Run Terrace locally, confirm the installation owner and record your first tenancy. You need Git and Node.js 22 or newer; the project command selects its pinned Node runtime.

Get Terrace and start it#

Install the RER command once, then clone the source and run it:

npx -y @runeditrun/rer@0.2.19 cli install
git clone https://github.com/just-every/run-terrace.git
cd run-terrace
rer dev

The first launch can take several minutes. rer dev installs dependencies, prepares the local database and development owner, applies migrations and starts the app. It prints the local address as RER_READY and a private sign-in link as RER_OPEN.

Open RER_OPEN on this computer. It is a credential: keep it private. On Finish setup, confirm the owner and finish setup to enter Terrace. Local sign-in and invitations use the development outbox; they send no external email.

For a new installation using your real owner mailbox, run rer setup before its first rer dev and enter the mailbox at the prompt. Preserve the owner identity in an existing installation. The repository's operating instructions cover deployment and provider configuration.

Add the first tenancy#

  1. Open Tenancies, then Add a tenancy.
  2. Enter the address, property owner's name and email, and tenant's name and email.
  3. Enter the lease start and end dates, rent in AUD and rent cadence: weekly, fortnightly or monthly.
  4. Select Add tenancy and check the saved details.

If you already have records to bring across, use Move in and follow the CSV guide. Terrace starts with your records; the repository's example CSV is an import fixture, not preloaded portfolio data.

Make the first working cycle#

Visit Rent & arrears to add a charge and record an amount received externally. Use Inspections & maintenance to save dated notes, retain a photograph and prepare a job. Review prepared work using an owner or admin account before approving it.

In Data & access, invite operators and download a backup when you have records to keep.

Stop and return later#

rer dev --stop

Run rer dev from the checkout again to return. It reuses a compatible running instance and keeps local records. If startup times out, run the same command again and follow its recovery message. Stop dev or preview before building or verifying. rer reset --yes removes local data and settings; it is not a startup repair step.