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.

Fast setup (recommended for a new campus):

1. School (super admin) — Add school; optionally enter a first campus name on the same form.
2. Campus setup — One form creates academic year, first grade, and first section (Admin → after saving campus, or Setup guide → Set up classes).
3. Add student — Profile, parents, portal login, and class enrollment on one form (keep Enroll now enabled).
4. Fee head — Add charge type; optionally set the first amount on the same form.

Detailed structure (when you need more later):
• Regions, curriculum boards, extra grades/sections, subjects — from the left menu under School structure.
• Separate pages still exist for academic years, grades, sections, enrollments, and fee structures when editing or bulk work.

The Admin dashboard shows a Setup guide plus How the school year works (campus → students → attendance → fees → exams → next class).

After login, admins land on the Dashboard with charts, Setup guide, How the school year works (6 steps), Daily operations (after setup), fee defaulters / recent invoices widgets, and Quick actions.

Setup guide — Tracks school, campus, campus setup, students, fees, and teachers. Minimize to collapse; progress is saved in your browser.

School year path — Campus ready → Students → Attendance → Fees → Exams → Next class.

Quick actions — Add student, invoices, exams, Promote class, attendance, bulk vouchers, reports, user manual.

Left sidebar sections:
• Administration — Settings (school name + logo, bank details), Regions, Users & roles (super admin)
• School structure — Schools, Campuses, Curriculum boards, Academic years, Grades, Sections
• People — Students, Parents, Enrollments, Promote class, Campus transfer, Teachers, Subjects
• Finance — Fee heads, Fee structures, Invoices, Monthly vouchers
• Academics — Attendance, Timetable, Exams, Reports & analytics
• Operations — Document library, Announcements, Discipline, Inventory, Library, Transport, Hostel, Payroll

Mobile — Full-width menu drawer, bottom tabs on portals, listing filters collapse on small screens.

Menu search and global search find students, teachers, invoices, and pages.

Campus switcher (super admin) filters lists. Login as troubleshoots portals — use Stop impersonating to return.

Follow this path every year:

1. Campus ready — Academic year, grades, and sections exist (Campus setup or School structure menu).
2. Add & enroll students — Use Add student with Enroll now, or import CSV then Enrollments import.
3. Mark attendance — Admin Attendance or Teacher portal Mark.
4. Fees & vouchers — Issue invoices / monthly vouchers; record payments.
5. Exams & report cards — Create exam, enter marks, print report cards.
6. Promote class — Pass / Repeat into the next year (create next academic year first).

Dashboard card “How the school year works” jumps to each step.

Adding a student (recommended — one form):
1. Admin → Students → Add student.
2. Fill admission number, name, campus, dates, guardian details (F/Name appears on the student ID card).
3. Class enrollment — keep Enroll now on; pick academic year, grade, and section.
4. Save once — student is created and enrolled together.
5. Optional: photo (used on ID card), CNIC scans, student portal login, link or create parent accounts.

Student ID card:
• Open the student → Student card, or listing → Card.
• Prints school logo, name, father/guardian, class, issued date, DOB, valid until (year end), address, photo, principal sign.
• Upload school logo under Settings so the card header shows branding.

Separate enrollment:
• Admin → Enrollments — Assign student to year, grade, section.
• Or import enrollments CSV (students must already exist).

After exams (next class):
1. Create the next academic year if needed.
2. Promote class — Pass or Repeat → new grade/section.

Parents — Admin → Parents; link on student profile; super admin can reset parent password.

Campus transfer — Move student with history preserved.

CSV — See “Search, filters & CSV” for import columns and Sample CSV buttons.

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 per campus for timetable and notes.

Timetable — Admin → Timetable: day, period, section, subject, teacher. Teachers only see sections on their timetable.

CSV import — Teachers list → Sample CSV or Export, then Import. Columns: campus_code, employee_code, full_name, phone, qualification, hire_date, is_active, is_shared.

Setup (fast path):
1. Admin → Fee heads → Add fee head.
2. On the same form, optionally fill First fee amount (academic year, grade, amount) — skips a separate fee structure step.

Setup (detailed):
• Fee structures — Add more amounts per grade/year when needed.

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 (card roster + P/A/L/E pills on mobile).
• Optional: WhatsApp alert to guardian when absent (if configured).
• Sticky save bar on mobile keeps Save reachable.

Teacher portal:
• Home → Today’s periods → Mark, or My classes → Mark attendance.
• Teachers only mark sections on their timetable.

Students and parents see recent attendance and a 30-day rate on portal KPIs.

Export CSV from the attendance list for reports.

Admin → Reports & analytics — Overview KPIs plus tabs for fees, attendance, low attendance, and exams.

• Filters — Campus, academic year, date range where shown.
• Overview — Snapshot metrics and grade distribution.
• Fees — Collections and outstanding summaries; open defaulter follow-up from dashboard widgets too.
• Attendance — Presence rates; Low attendance highlights students needing follow-up.
• Exams — Published results overview.

On mobile, report tables stack as cards for easier reading.

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.

Admin → Settings (school / campus / super admin):
• School display name — Shown on portals, vouchers, and student cards.
• School logo — Upload PNG/JPG (max 2 MB). Used on student ID cards and school branding. Preview appears after Save; use Remove logo to clear.
• Fee voucher bank details — Printed on fee invoices and monthly vouchers.

Also set logo on Admin → Schools → Edit (super/school admin) — kept in sync with Settings.

Tip: After uploading a logo, hard-refresh (Ctrl+F5) if the old image is cached. Student card embeds the logo for reliable printing.

Home — KPI strip (classes, today’s periods, announcements, payslips), quick actions, today’s periods with Mark, timetable, announcements, salary slips.

Mobile bottom tabs — Home, Classes, Timetable, Alerts, Menu.

My classes — Card grid for each section:
• Mark — Daily attendance.
• Roster — Student list.
• Notes — Class notes for students/parents.
• Diary — Daily homework / summary.
• Log — Attendance history.

Sidebar Jump to — Timetable, today, announcements, salary, documents, notifications.

Documents & Profile — Same as before.

You cannot access admin menus or other teachers’ sections.

Home — KPIs (children, outstanding fees, invoices, notices), quick actions, children cards with attendance %, class notes, diary, recent attendance.

Children timetable — Periods by day for each child’s section.

Fees — Invoices and monthly vouchers with pay/print where enabled.

Exam results — Published marks per child.

Mobile tabs — Home, Children, Fees, Timetable, Menu.

Documents & notifications — From quick actions or sidebar Jump to.

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

Home — KPIs (30-day attendance %, outstanding fees, periods, exams), quick actions to timetable, attendance, fees, exams, diary, documents.

Sections on home:
• Announcements, timetable, class notes, daily diary
• Recent attendance, fee invoices, monthly vouchers, exam results

Mobile tabs — Home, Timetable, Attendance, Fees, Menu.

Profile — Update allowed fields and password.

You cannot see other students’ data.

Most admin lists share the same toolbar:
• Search, campus, status, grade/year filters where available.
• Apply filters / Clear — URL updates so you can bookmark the view.
• Per page — 10 to 100 rows.
• Export CSV — Up to 10,000 filtered rows (UTF-8 BOM for Excel).
• Sample CSV + Import CSV — Students, Teachers, and Enrollments.

Import tips:
1. Download Sample CSV (or Export) so columns match.
2. campus_code must match your campus (case-insensitive).
3. Excel-friendly BOM is supported when re-importing sample/export files.
4. Max ~2,000 data rows per file; errors show as Import notes.

Students columns: campus_code, admission_number, first_name, last_name, date_of_birth, gender, admission_date, is_active.
Teachers columns: campus_code, employee_code, full_name, phone, qualification, hire_date, is_active, is_shared.
Enrollments columns: campus_code, admission_number, year, grade, section, status, enrolled_on (students must already exist).

On mobile, listing rows can show as cards; use the Menu drawer for filters.

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 for Urdu).

Preferences are saved in your browser.

School branding — Upload logo and display name under Admin → Settings (see Settings & school logo).

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

PWA — Use Install app on supported browsers, or Add to Home Screen on iOS Safari.

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

Page expired (419) — Refresh and submit again.

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

Logo not showing — Re-upload under Settings; hard-refresh (Ctrl+F5). Local and live hosts both use /storage/... paths. Confirm public/storage link exists (php artisan storage:link).

Student not in class list — Enroll now on add form, or check enrollment + teacher timetable.

Parent cannot see child — Link parent on the student record.

Import skipped all rows — Invalid campus_code, or use Sample CSV headers. Check Import notes after upload.

WhatsApp not sending — Campus bridge URL; guardian WhatsApp number; queue worker if queued.

Empty dashboard — Complete setup guide; Campus setup; add enrolled student.

For technical issues, send screenshot, role, and campus name to your system administrator.

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

Available in this version: exams & report cards, student ID cards, school logo in Settings, CSV import (students / teachers / enrollments), advanced reports, payroll slips, portal KPIs & mobile tabs, online pay, and mobile API endpoints.