Onboarding Module User Guide (Non-Technical)

This guide explains how a new school can create its institute workspace for first-time use.

Who should use this

• New school owners
• Principal or headmaster starting the system
• Authorized setup staff creating the first school account

What onboarding does

Onboarding creates:

1. a new school tenant workspace
2. school subdomain (or custom domain)
3. owner account (first admin-level account)

---

Before you start

Keep these ready:

• official school name
• preferred subdomain name
• optional custom domain (if already configured)
• timezone and currency preference
• owner name and owner email
• owner password

---

1) Open onboarding

From the main website:

1. click Get Started
2. onboarding form opens

---

2) Fill institute details

Complete these fields:

1. Institute name (required)
2. Subdomain (required)
3. Custom domain (optional)
4. Timezone (optional)
5. Currency (optional)

Subdomain rules

• use lowercase letters, numbers, and dashes only
• must be unique
• must not be reserved

The form checks subdomain availability automatically and shows status feedback.

---

3) Fill owner account details

Complete these fields:

1. Headmaster name (required)
2. Headmaster email (required, unique)
3. Password (required)
4. Confirm password (must match)

---

4) Create institute

1. Click Create institute.
2. Wait for processing.
3. On success, you are redirected to onboarding completion page.

Completion page shows:

• institute name
• owner email
• login URL for the new school workspace

Click Go to login to start using the system.

---

What happens after onboarding

After successful onboarding:

• school tenant is created
• owner account is created and assigned top-level admin role for that school
• school-specific login URL is generated

---

Common issues and quick fixes

• Subdomain unavailable: choose a different unique subdomain.
• Invalid subdomain format: use only lowercase letters, numbers, and dashes.
• Owner email already used: use another email that is not already registered.
• Password mismatch: password and confirm password must be identical.
• Could not continue from completion page: reopen login URL shown on completion screen.

---

If users do not see latest UI updates, ask technical support to run frontend build/dev commands (npm run build or npm run dev).