Help center

Getting started

A practical 30-minute walkthrough from fresh signup to your first community fully on the portal.

1. Set up your community

After signup you land at /admin on your community subdomain (e.g. yourestate.hoaportalgh.com). First stop: /admin/settings → Branding.

  • Set your community name (shown in emails, headers, WhatsApp).
  • Pick a brand color — drives buttons, links, email accents.
  • Upload a logo URL (square PNG/SVG, ≥200×200) — appears on the login screen and the portal sidebar.
  • Optional but recommended: upload a login background image(e.g. a photo of the estate's gate). Shows on every public/auth page.
  • Confirm your currency (defaults to GHS) and default monthly dues.

2. Import your residents

Go to /admin/residents. Two ways to load people in:

Option A — Bulk import (recommended for >10 households)

Click Bulk import in the top right. Download the CSV template, fill it in from your spreadsheet (or paste columns from Excel / Google Sheets), and upload. Required columns:

  • house_number — uniquely identifies the household.
  • street — street name; residents are grouped by street in the UI.
  • primary_name — name of the head of household.
  • email and/or phone — at least one required for invites.

Optional: secondary_name, alt_phone, monthly_dues (if it differs from the community default), move_in_date.

Option B — Add one at a time

Click Add resident. Useful when onboarding move-ins after launch.

3. Invite everyone to the portal

Back on /admin/residents, click Invite everyone. This:

  • Generates a 14-day single-use invite link for every active resident without a login.
  • Sends it via email + WhatsApp + SMS — whichever contact channels each resident has on file (and whichever channels the system can send through).
  • Skips residents who already have a login. Safe to re-run if some residents miss their first invite.

The toast shows the per-channel result (e.g. 47 residents · 📧 42/44 · 💬 38/44 · 📱 SMS 41/44) with an expandable failure list.

Want to send to one specific resident only? Open their profile at /admin/residents/[id] and use the Generate invite link + Send via email + WhatsApp + SMS buttons there.

4. Set up communications (recommended)

By default, your community sends through the platform's system email and SMS accounts. That works out of the box. Skip ahead if you're happy with that — or configure your own if you want a custom sender ID / separate billing:

  • Email (SMTP): /admin/settings → Email (SMTP). Paste in your Gmail App Password, SendGrid, Resend, or Zoho creds.
  • WhatsApp: /admin/whatsapp. Scan the QR code from the community's WhatsApp number (treasurer's phone usually works).
  • SMS: /admin/settings → SMS (mNotify). Paste your mNotify API key and sender ID.

Each section has a Send test button — use it to verify before relying on the channel for residents.

5. Turn on automated reminders

/admin/settings → Automated dues reminders. Pick days of the month (e.g. 5, 15, 25) and which channels to use. Residents behind on dues get a polite nudge with their balance.

6. Done — what residents see

After they accept their invite and set a password, residents land on /dashboard showing their statement, current balance, recent payments, and any active notices. They can /pay directly online (if Paystack is enabled) or upload payment evidence for you to review.

And that's it — your community is live. The other articles in the help center cover specific features once you're past the setup.

Need a hand? Email us — or check the FAQ for quick answers.