Documentation Center

Login to Your Account

Navigate to the login page and enter your email and password provided by your administrator.

Dashboard Overview

After login, you'll see your role-specific dashboard with key metrics, quick actions, and recent activity.

Sidebar Navigation

Use the left sidebar to access modules — organized by: People, Academic, Educational, Finance, etc.

Update Your Profile

Click your avatar in the top-right to update personal info, change password, and upload a photo.

Switch Language

Use the language selector to switch between English, French, and Arabic instantly.

Access Profile

Click your name/avatar in the top-right corner and select "Profile".

Edit Information

Update your name, email, phone, and address fields.

Change Password

Enter your current password and set a new one in the password section.

Upload Photo

Click the photo area to upload a new profile picture (JPG/PNG).

Open Calendar

Click "General Calendar" from the sidebar to view the unified calendar.

Browse Events

Navigate between months. Events, holidays, and exams are color-coded.

View Details

Click on any calendar entry to see full details.

View Students List

Go to People → Students from the sidebar.

Add Student

Click "+ Add Student". Fill: first name, last name, DOB, gender, contact info.

Assign to Group

Select academic level and group. Assign parent representatives.

Import Students

Use Import/Export to bulk-import from Excel/CSV. Download template first.

Export Data

Export the student list in PDF, Excel, or CSV format.

View Teachers

Go to People → Teachers from the sidebar.

Add Teacher

Click "+ Add Teacher". Fill personal info, subjects, and employment type.

Replace Teacher

Use the Replace action to transfer all assignments to another teacher.

Import/Export

Bulk import from Excel/CSV or export for reporting.

Enable/Disable

Toggle teacher account status without deleting their record.

View Parents

Go to People → Parents from the sidebar.

Add Parent

Click "+ Add Parent". Enter personal details and contact info.

Link Students

Associate the parent with their children from the student list.

Generate Invoice

Use "Generate Invoice" from a parent profile to create billing documents.

Import/Export

Bulk import or export parent data.

View Staff

Go to People → Staff from the sidebar.

Add Staff

Click "+ Add Staff". Fill personal details, role, and department.

Edit Staff

Click a staff member to view/edit their profile.

Import/Export

Bulk import or export staff data.

View Users

Go to People → Users from the sidebar.

Create User

Click "+ Add User". Select type, enter email, set password.

Enable/Disable

Toggle user access without deleting the account.

Reset Password

Use "Update Password" to reset a user's password.

Deleted Users

View deleted users to restore or permanently remove accounts.

Navigate to Parents

Go to People → Parents from the sidebar.

Click Create User

Find the "Create User" action button in the Parents List.

Fill Details

Enter email and password for the parent user account.

• Email
• Password
• Confirm Password

Save

Click Save. The parent will receive login credentials.

Navigate to Teachers

Go to People → Teachers from the sidebar.

Click Create User

Find the "Create User" action in the teacher row.

Fill Details

Enter email and password.

• Email
• Password
• Confirm Password

Save

Click Save to create the account.

Navigate to Students

Go to People → Students from the sidebar.

Click Create User

Find the "Create User" action in the student row.

Fill Details

Enter login credentials.

• Email
• Password
• Confirm Password

Save

Click Save to create the account.

Navigate to Users

Go to People → Users from the sidebar.

Click Add User

Click "+ Add User" and select Admin type.

Fill Details

Enter all required fields.

• Name
• Email
• Password
• Role

Assign Role

Select the admin role with appropriate permissions.

Create Level

Go to Academic → Levels. Click "+ Add". Enter name (e.g., Primary, Secondary).

Create Academic Level

Go to Academic → Academic Levels. Select parent level, enter grade name.

View & Edit

Click on any level to view details or edit.

Export

Export data in PDF, Excel or CSV.

View Groups

Go to Educational → Groups from the sidebar.

Create Group

Click "+ Add". Select academic level, enter name, and set capacity.

Assign Students

Add students to the group via the assignment interface.

Export

Export group rosters in multiple formats.

View Academic Years

Go to Academic → Academic Years.

Create Year

Click "+ Add". Enter year name, start date, and end date.

Set Active

Click "Set Active" to make it the current academic year.

Edit Year

Modify dates or name of existing years.

View Semesters

Go to Academic → Semesters.

Create Semester

Click "+ Add". Select year, enter name, start and end dates.

Edit

Modify semester details as needed.

View Halls

Go to Academic → Halls.

Add Hall

Click "+ Add". Enter name, capacity, floor, and type.

Import

Bulk-add rooms from a template file.

Export

Export halls list in multiple formats.

View Timetables

Go to Academic → Timetables.

Create Entry

Click "+ Add". Select day, time, course, teacher, group, and hall.

View Grid

Use the list/grid view for the weekly schedule.

Import/Export

Bulk import or export timetable data.

View Holidays

Go to Academic → Holidays.

Add Holiday

Click "+ Add". Enter name, dates, and description.

Import

Bulk-add holidays from a template.

View Subjects

Go to Educational → Subjects.

Add Subject

Click "+ Add". Enter name, code, and description.

Sub-Subjects

Create topic divisions within a subject.

Import/Export

Bulk import or export subject data.

View Courses

Go to Educational → Courses.

Create Course

Click "+ Add". Select subject, teacher, group, semester, set hours.

Edit Course

Modify assignments and details.

Export

Export course data in multiple formats.

View Rules

Go to Educational → Coefficient Rules.

Add Rule

Click "+ Add". Select level, subject, and set coefficient value.

Edit

Adjust coefficient values for existing rules.

Navigate to Assignments

Go to the Assignments section from the main menu.

Create Assignment

Click "+ Add" to create a new assignment.

Fill Details

Enter all required information.

• Group
• Title
• Description
• Due date
• Files (optional)

Save

Click Save to create the assignment.

Grade Submissions

View student submissions and provide grades and feedback.

View Grades

Go to Educational → Semester Notes.

Add Grade

Click "+ Add". Select student, subject, semester, enter grade.

Import Grades

Bulk-upload from Excel. Download template first.

• Download template
• Fill in grades
• Upload file
• Review results

Export

Export grade data for bulletins and reports.

View Sessions

Go to Educational → Session Sheets.

Create Sheet

Click "+ Add". Select course, date, enter objectives and content.

Download PDF

Generate a PDF of the session sheet.

Edit

Modify session details and notes.

View Exams

Go to Educational → Exams.

Create Exam

Click "+ Add". Enter name, subject, group, date, max marks.

Enter Marks

Click "Mark" to enter grades for each student.

View Results

See scores, charts, and performance analytics in Exam Results.

Export

Export results in PDF, Excel, or CSV.

View Attendance

Go to Educational → Student Attendances.

Mark Attendance

Select date and group. Mark each student as Present, Absent, or Late.

Bulk Mark

Use bulk actions to mark all students at once.

Export

Export attendance records in multiple formats.

View Attendance

Go to Educational → Teacher Attendances.

Mark Attendance

Record teacher presence for each session.

View History

Browse attendance history and filter by date range.

Export

Export attendance data for HR reporting.

View Grids

Go to Educational → Evaluation Grids.

Create Grid

Click "+ Add". Define competency criteria and assessment scale.

Evaluate

Select a student and semester to complete the evaluation.

Export PDF

Generate individual or class evaluation reports.

Navigate to KOLB

Go to Educational → KOLB Test.

Start Test

Click "Take Test". Select the student to evaluate.

Answer Questions

Complete the KOLB questionnaire by ranking learning preferences.

View Results

See the learning style profile and detailed analysis.

Export

Export results as PDF for student records.

Navigate to MI

Go to Educational → Multiple Intelligences.

Create Test

Click "+ Add". Select a student and begin assessment.

Complete Assessment

Answer the questionnaire to evaluate the intelligence profile.

View Results

See the radar chart showing all intelligence types and scores.

Export

Export individual or group results as PDF.

Navigate to Assessments

Go to Educational → Learning Assessments.

Start Assessment

Select a student and begin the learning evaluation.

Complete Evaluation

Fill in the assessment criteria and scores.

View Results

See detailed results and progress indicators.

Export PDF

Download individual or group reports.

View Evaluations

Go to Educational → Teacher Evaluations.

Create Evaluation

Select a teacher and fill the evaluation form.

View Results

See evaluation scores and feedback.

Download Report

Export evaluation results.

View Promotions

Go to Educational → Promotions.

Promote Students

Select groups and define promotion rules (pass/fail criteria).

Close Year

Use "Close Year" to finalize the academic year and archive data.

View Events

Go to Events from the sidebar.

Create Event

Click "+ Add". Enter title, description, dates, location, and target audience.

Edit/Delete

Manage existing events with edit and delete actions.

Import/Export

Bulk manage events with import/export features.

View Notices

Go to Notices from the sidebar.

Create Notice

Click "+ Add". Enter title, content, and target audience.

Edit/Delete

Manage existing notices.

Export

Export notices for record-keeping.

View Notifications

Click the bell icon in the header or go to Notifications.

Mark as Read

Click a notification to mark it as read.

Mark All Read

Use "Mark All as Read" to clear all notifications.

View Tasks

Go to Operations → Tasks. Switch between List, Kanban, and Calendar views.

Create Task

Click "+ Add". Set title, description, assignee, priority, due date, and type.

Update Status

Drag tasks on Kanban board or use status dropdown to update progress.

Add Comments

Use the comments section to collaborate with team members.

Attach Files

Upload attachments to tasks for reference.

View Tickets

Go to Operations → Tickets.

Create Ticket

Click "+ Add". Enter subject, description, and priority.

Reply

Open a ticket and use the reply form to respond.

Close/Reopen

Close resolved tickets or reopen them if needed.

View Support Tickets

Go to Operations → Support Tickets.

Create Ticket

Click "+ Add". Describe your issue, set priority.

Reply

Communicate with support via the reply system.

Track Status

Monitor ticket status: Open, In Progress, Resolved.

View Lost Objects

Go to Operations → Lost & Found.

Report Item

Click "+ Add". Describe the item, location found, and date.

Claim Item

Browse lost items and submit a claim for your property.

Manage Returns

Admins can approve claims and mark items as returned.

View Fees

Go to Finance → Fees.

Create Fee

Click "+ Add". Enter name, amount, type, and applicable levels.

Import Fees

Bulk import fees from a template file.

Export

Export fee data for accounting.

View Subscriptions

Go to Finance → Subscriptions.

Create Subscription

Click "+ Add". Select parent, student(s), and fee plan.

Enable/Disable

Toggle subscription status as needed.

Export

Export subscription data.

View Invoices

Go to Finance → Invoices.

Create Invoice

Click "+ Add". Select parent, student, fees, and set due date.

Record Payment

Click "Record Payment" to log full or partial payments.

Apply Reduction

Use the reduction feature to apply discounts.

Export PDF

Generate invoice PDF for printing or emailing.

Statistics

View invoice statistics for financial overview.

Navigate to Import

Go to Educational → Semester Notes → Import/Export.

Download Template

Download the Excel template with student names pre-filled.

Fill Grades

Enter grades in the template following the format.

• Use numeric values
• Don't modify student IDs
• Save as .xlsx format

Upload File

Upload the completed template and review the import results.

View Payroll

Go to Finance → Payroll.

Generate Payroll

Click "Generate". Select teachers, month, and calculate amounts.

Approve

Review and approve payroll entries.

Mark as Paid

Mark approved payroll as paid after disbursement.

Export

Export payroll data for accounting records.

View Commissions

Go to Finance → Teacher Fee Commissions.

Assign Commission

Click "+ Add". Select teacher, fee type, and commission rate.

View Records

Go to Commission Records to see calculated amounts.

Export

Export commission data for accounting.

View Hours

Go to HR → Working Hours.

Log Hours

Click "+ Add". Enter date, hours worked, and description.

Approve/Reject

Managers can approve or reject submitted hours.

Export

Export working hours data for payroll.

View Leaves

Go to HR → Leave Requests.

Apply for Leave

Click "+ Add". Select leave type, dates, and reason.

Manage Types

Admins can create/edit leave types (Sick, Vacation, etc.).

Approve/Reject

Managers review and approve or reject leave requests.

Browse Library

Go to Library from the sidebar to browse available books.

Add Books

Go to Manage → Add Book. Enter title, author, ISBN, category.

Manage Copies

Track individual copies and their availability status.

Borrow/Return

Use Circulation to check out and return books.

My Borrowings

Students/teachers can view their current borrowings.

View Transport

Go to Transport from the sidebar.

Add Vehicles

Go to Manage → Vehicles. Add vehicle info and capacity.

Add Drivers

Register drivers with contact and license details.

Create Routes

Define routes with stops, pickup/drop times.

Assign Students

Assign students to routes via the assignments page.

Browse Courses

Go to LMS from the sidebar to see available courses.

Create Course

Go to Manage → Create. Enter title, description, and assign groups.

Add Content

Build course syllabus with Sections → Lessons (text, video, files).

Create Quizzes

Add quizzes to lessons for student assessment.

Enroll & Track

Students enroll and track progress. Teachers view enrollments.

Registration Periods

Go to Pre-Registration → Periods. Create open registration windows.

View Applications

Go to Pre-Registrations to see all submitted applications.

Review & Approve

Click an application to review details, then approve or reject.

Manage Documents

Upload and download required registration documents.

Export Data

Export application data for reporting.

View Roles

Go to Administration → Roles.

Create Role

Click "+ Add". Enter name and select permissions for the role.

Edit Permissions

Check/uncheck permissions for each module and action.

Duplicate Role

Use "Duplicate" to create a new role based on an existing one.

View Modules

Go to Administration → Modules.

Enable/Disable

Toggle modules on or off for your school.

Request Module

Request activation of additional modules from the platform admin.

Module Settings

Configure module-specific settings.

Access Settings

Go to Administration → School Settings.

Update School Info

Edit school name, logo, address, and contact information.

Bank Details

Add or edit bank account details for payment processing.

Save Changes

Click Save to apply your changes.

View Subscription

Check your current plan status in the billing section.

View Invoices

See platform billing invoices and payment history.

Upgrade Plan

Contact support or use the billing portal to upgrade your subscription.

Endpoint Structure

All v1 endpoints are prefixed with /api/v1/. Use plural nouns (e.g., /api/v1/students).

Authentication

Use Laravel Sanctum or JWT. Include "Authorization: Bearer {token}" in your headers.

Response Format

All responses are JSON with a standard envelope: {success: true, data: ..., message: ...}.

Pagination

List endpoints support ?per_page and ?page parameters for navigation.

Initialization

Call GET /api/v1/config/init right after login to fetch school info, user permissions, and active semesters.

Push Notifications

After FCM initialization in Flutter, send the token to POST /api/v1/profile/fcm-token.

Localization

Fetch backend translations using GET /api/v1/config/translations/{lang} for app consistency.

Asset Management

Images and files are stored on S3. Use the absolute URLs provided in the API responses.