User manual

1. Open Log in from the home page or top navigation.
2. Enter your email and password. If demo hints are enabled (local/testing only), use the Fill button on the login page.
3. After login you are sent to the correct home for your role:
• Super admin / Regional admin / Campus admin → Admin dashboard
• Teacher → Teacher portal
• Parent → Parent portal
• Student → Student portal
4. Use Forgot password if you need a reset link (requires mail to be configured on the server).
5. Change your password anytime from My profile.

Tip: Keep the same browser address (e.g. always 127.0.0.1 or always localhost) — mixing them can break sessions.

Six roles control what you can see:

• Super admin — Full system: schools, regions, campuses, users, settings, impersonation (login as another user). Can switch campus filter in the top bar.
• Regional admin — All campuses in their assigned region only.
• Campus admin — Assigned campus(es) only: students, fees, attendance, staff, operations.
• Teacher — Portal only: classes, attendance, class notes, daily diary, announcements for their campus.
• Parent — Portal only: linked children, fees, vouchers, announcements, documents.
• Student — Portal only: own profile, attendance, timetable, fees, announcements, documents.

Security: Each admin only sees data for campuses they are allowed to access. Parents and students cannot open another child's records.

Build the hierarchy in this order:

1. School (super admin) — Chain or group name, logo.
2. Region (super admin) — Geographic or administrative grouping.
3. Campus — Physical branch; assign curriculum board, contact info, payment/WhatsApp settings.
4. Academic year — Mark one as current for enrollments and fees.
5. Grades — e.g. Class 1–10, O-Level, A-Level (per campus).
6. Sections — e.g. A, B, Morning (per grade).
7. Subjects — For timetable and class notes.

Then add teachers, students, and enroll each student into a section for the current academic year.

The Admin dashboard shows a Setup guide checklist until core steps are complete. Follow it for first-time onboarding.

After login, admins land on the Dashboard with charts (enrollment, fees, attendance overview) and the setup guide.

Left sidebar sections:
• Administration (super admin only) — Settings, Regions, Users & roles
• School structure — Schools, Campuses, Curriculum boards, Academic years, Grades, Sections
• People — Students, Parents, Enrollments, Campus transfer, Teachers, Subjects
• Finance — Fee heads, Fee structures, Invoices, Monthly vouchers
• Operations — Attendance, Timetable, Document library, Announcements, Discipline, Inventory, Library, Transport, Hostel

Use the menu search box to find any page quickly.

Campus switcher (top bar, super admin): Filter lists to one campus or view all.

Super admin can use Login as on a user row to troubleshoot portal issues — click Stop impersonating to return.

Adding a student:
1. Admin → Students → Add student.
2. Fill admission number, name, campus, dates, guardian details.
3. Optional: upload photo and CNIC scan; enable portal account (auto-creates login).
4. Link an existing parent or create a new parent account from the student form.

Enrollment:
• Admin → Enrollments — Assign student to academic year, grade, and section.
• A student needs an active enrollment to appear in attendance and teacher class lists.

Parents:
• Admin → Parents — Lists guardians and how many children are linked.
• Super admin can reset a parent password (one-time password shown once).

Campus transfer:
• Admin → Campus transfer — Move a student to another campus with history preserved.

CSV import/export:
• Export first to get the correct column format.
• Import students: campus_code, admission_number, first_name, last_name, date_of_birth, gender, admission_date, is_active.
• Duplicates per campus are skipped with warnings.

Teachers:
1. Admin → Teachers → Add teacher with employee code, campus, qualification, hire date.
2. Mark is_shared if the teacher works across campuses (needs can_teach_all_campuses on user).
3. Link the teacher to a portal user account for login.

Subjects:
• Admin → Subjects — Define subjects per campus for timetable and notes.

Timetable:
• Admin → Timetable — Create slots: day, period, section, subject, assigned teacher.
• Teachers only see sections where they appear on the timetable.

CSV import for teachers: campus_code, employee_code, full_name, phone, qualification, hire_date, is_active, is_shared.

Setup:
1. Fee heads — Individual charge types (tuition, transport, exam fee, etc.).
2. Fee structures — Bundle heads with amounts for a grade/campus/year.

Invoices (per-student bills):
• Create invoice → select student → add line items → record payments.
• Status updates automatically when fully paid.
• Print invoice or save as PDF from the print view.
• Parents/students can pay online via JazzCash, Easypaisa, HBL, or UBL when gateways are configured (simulate mode in local dev).
• Notify via WhatsApp if guardian WhatsApp number is set and campus WhatsApp is configured.

Monthly vouchers (bulk monthly billing):
• Create voucher for a campus/month → add items or Fill from structure.
• Record payments same as invoices; online pay supported on portal.
• Parents and students see vouchers in their portal.

Payment methods recorded: cash, bank, HBL, UBL, JazzCash, Easypaisa, other.

Admin bulk entry:
• Admin → Attendance — Pick date, campus, section.
• Mark each student present, absent, late, or excused.
• Optional: send WhatsApp alert to guardian when absent (if configured).

Teacher portal:
• Teacher → My classes → select section → Mark attendance.
• Teachers can only mark sections on their timetable.

Students and parents see attendance summary in the student/parent portal.

Export CSV from the attendance list for reports.

Announcements:
• Admin → Announcements — Create notice for one campus or all campuses.
• Pin important items; set publish date for scheduling.
• Rich text supported; shown in admin and relevant portals.

Document library:
• Admin → Document library — Upload policies, forms, exam schedules (category + optional publish date).
• Teachers, parents, and students download from Portal → Documents.
• Downloads are rate-limited for security.

Campus WhatsApp (admin):
• Campus detail → WhatsApp — Connect external bridge service, manage session, create message templates.
• Use templates when sending fee or attendance notifications.
• Bulk send available for authorized admins.

SMS: System logs SMS by default; connect a real provider in server configuration for production.

Discipline — Record student incidents (date, type, description, action taken).

Inventory — Track stock items per campus (quantity, location, notes).

Library — Books catalog + Loans (issue/return with due dates).

Transport — Define routes (name, vehicle, driver contact, fee link optional).

Hostel — Room inventory (room number, capacity, gender, status).

All operation modules support list filters, campus scoping, and CSV export where shown on the index page.

Home — Today's timetable slots and recent announcements.

My classes — Sections you teach (from timetable):
• Roster — Student list for the section.
• Attendance — Mark daily attendance; optional WhatsApp for absences.
• Class notes — Post notes visible to enrolled students and parents.
• Daily diary — Homework / class summary for the day.

Announcements — Read campus and school-wide notices.

Documents — Download published school documents.

Profile — Update name, phone, password.

You cannot access admin menus or other teachers' sections.

Home shows each linked child with quick links.

For each child you can view:
• Fee invoices — Open detail, see items and payment history.
• Monthly vouchers — Campus monthly billing statements.
• Announcements — Only for your child's campus.

Documents — School-wide files published for parents.

Profile — Update your contact details and password.

You only see children linked to your account by the school admin. If a child is missing, contact the campus office.

Home shows your profile summary:
• Timetable — Weekly schedule from admin timetable.
• Attendance — Recent attendance records.
• Fees — Open invoices and payment status.
• Monthly vouchers — If issued by campus.
• Daily diary & class notes — From your teachers.
• Announcements — Campus and school notices.

Documents — Download published files.

Profile — Update allowed fields and change password.

You cannot see other students' data.

Most admin lists share the same toolbar:
• Search — Name, code, admission number, etc.
• Campus filter — Limit to one campus.
• Status — Active / inactive where applicable.
• Apply filters — Updates the URL so you can bookmark or share the view.
• Per page — 10 to 100 rows.
• Export CSV — Downloads up to 10,000 filtered rows (UTF-8 BOM for Excel).
• Import CSV — Students and teachers only; max ~2,000 rows per file.

DataTables pages load rows via AJAX for large datasets — wait for the table to finish loading before exporting.

Display settings (sliders icon in top bar):
• Theme — Light or dark mode.
• Zoom — Page scale for readability.
• Font size — Small, medium, or large.
• Language — English or Urdu (RTL layout for Urdu).

Preferences are saved in your browser.

My profile — Change name, phone, email (if allowed), and password. Always use a strong password in production.

Cannot log in — Check email/password; wait if rate-limited after many attempts; ask admin to reset password.

Page expired (419) — Refresh and submit again; session may have timed out.

CSRF / session errors — Use one consistent URL (APP_URL); clear cookies; try another browser.

Student not in class list — Verify enrollment for current academic year and timetable slot for the teacher.

Parent cannot see child — Admin must link parent to student on the student record.

WhatsApp not sending — Configure campus WhatsApp bridge URL; check guardian WhatsApp number on student; ensure queue worker is running if notifications are queued.

Empty dashboard — Complete setup guide steps; ensure academic year and enrollments exist.

For technical issues, contact your system administrator with screenshot, role, and campus name.

Still optional or environment-dependent:
• Email verification on signup
• Native iOS/Android store apps (use PWA install + Sanctum API)
• Production payment gateways need merchant credentials in .env (JazzCash, Easypaisa, HBL, UBL); local/dev uses simulate mode
• SMS needs SMS_DRIVER=http and your provider endpoint

Exams, marks, report cards, payroll slips, portal online pay, and mobile API endpoints are available in this version.