System Requirements Document (SRD)

jade-school

1. Introduction

The jade-school project is a comprehensive school management system designed to streamline and enhance the administrative, academic, and communication processes within educational institutions. This document outlines the system requirements for the development of both a website and a mobile application tailored to meet the needs of administrators, teachers, students, and parents.

The system will cater to the specific needs of schools in India, ensuring compliance with local standards, time zones (IST), and currency (INR).

2. System Overview

The jade-school system will provide a centralized platform for managing school operations. It will feature role-based dashboards for administrators, teachers, students, and parents, offering tools for attendance tracking, fee management, academic performance monitoring, and communication.

The system will be accessible via a responsive web application and a mobile app, ensuring seamless access across devices. Security, user-friendliness, and scalability will be key priorities.

3. Functional Requirements

Authentication and Account Management

• As a User, I should be able to register and log in securely.
• As an Admin, I should be able to approve or reject user registrations.
• As a User, I should be able to reset my password if forgotten.

Admin Dashboard

• As an Admin, I should be able to manage student records (add, edit, delete, view).
• As an Admin, I should be able to manage teacher records (add, edit, delete, view).
• As an Admin, I should be able to create and manage fee structures.
• As an Admin, I should be able to publish notices and target specific user groups.
• As an Admin, I should be able to manage class schedules, timetables, and exam schedules.
• As an Admin, I should be able to generate reports and analytics.

Teacher Dashboard

• As a Teacher, I should be able to mark attendance for my classes.
• As a Teacher, I should be able to assign grades and track student performance.
• As a Teacher, I should be able to communicate with parents.

Student Dashboard

• As a Student, I should be able to view my timetable, grades, and attendance records.
• As a Student, I should be able to submit assignments.
• As a Student, I should be able to view notices and exam schedules.

Parent Dashboard

• As a Parent, I should be able to track my child’s attendance and academic performance.
• As a Parent, I should be able to pay fees online and view payment history.
• As a Parent, I should be able to communicate with teachers.

4. User Personas

Admin

• Role: School Administrator
• Responsibilities: Full system management, user approval, data oversight.

Teacher

• Role: Educator
• Responsibilities: Class management, attendance, grading, communication.

Student

• Role: Learner
• Responsibilities: Access academic resources, submit assignments, track progress.

Parent

• Role: Guardian
• Responsibilities: Monitor child’s progress, pay fees, communicate with teachers.

5. Visuals Colors and Theme

Color Palette

• Background: #F5F9FF (Soft Sky Blue)
• Surface: #FFFFFF (Pure White)
• Text: #2D2D2D (Charcoal Black)
• Accent: #FF6F61 (Coral Red)
• Muted: #B0BEC5 (Cool Gray)

Theme

The theme will reflect a modern, professional, and approachable aesthetic, suitable for an educational institution.

6. Signature Design Concept

Interactive Chalkboard Landing Page

The homepage will feature an interactive chalkboard design. Users will see a virtual chalkboard with animated chalk writing that introduces the system’s features. As users hover over menu items, chalk-like animations will draw icons and text.

Key interactions:

• Clicking on a menu item will trigger a “chalk swipe” transition to the next page.
• Subtle eraser animations will clear sections of the chalkboard when navigating back.
• The background will feature a soft classroom ambiance with faint sounds of chalk on a board.

This design will create a nostalgic yet modern experience, instantly connecting users to the educational theme.

7. Non-Functional Requirements

• The system must support at least 10,000 concurrent users.
• Data must be encrypted in transit and at rest.
• The system should load within 3 seconds on a 3G connection.
• The mobile app must be compatible with Android 8.0+ and iOS 12.0+.

8. Tech Stack

Frontend

• React for Web
• React Native for Mobile

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Models

• GPT 5.4 for user-friendly responses
• Claude 4.6 Opas for academic or coding work

AI Tools

• Litellm for LLM Routing
• Langchain

Orchestration

• Docker
• Kubernetes

9. Assumptions and Constraints

• The system will operate in IST (Indian Standard Time).
• All financial transactions will be in INR.
• The school will provide the necessary branding assets (logo, images).
• Internet connectivity is required for full functionality.

10. Glossary

• CRUD: Create, Read, Update, Delete
• IST: Indian Standard Time
• RDBMS: Relational Database Management System
• LLM: Large Language Model