System Requirements Document (SRD)

Project Name: mint-school

1. Introduction

The mint-school project is a comprehensive school management system designed to streamline and optimize the operations of educational institutions. Developed for users in India (IN), this system aims to cater to the unique needs of schools, including administrators, teachers, students, and parents. By integrating modern technology and intuitive design, mint-school will enhance efficiency, communication, and overall management of school activities.

This document outlines the system requirements for mint-school, ensuring all functionalities and features are clearly defined and aligned with Mahmood Saiyed's vision.

2. System Overview

mint-school is a centralized platform that provides tailored dashboards for different user roles, enabling seamless management of school operations. The system will include features such as attendance tracking, grade management, timetable scheduling, fee management, communication tools, admission management, and library tracking. It will also offer optional add-ons like e-learning modules, online exams, and analytics dashboards for advanced functionality.

The system will be accessible via web and mobile applications, ensuring convenience and accessibility for all users. Locale-specific defaults, such as Indian Rupees (₹) for currency and IST (Indian Standard Time) for timezone, will be incorporated to suit the target audience.

3. Functional Requirements

As Administrator:

• As Administrator I should be able to manage school-wide attendance records.
• As Administrator I should be able to oversee fee collection and generate financial reports.
• As Administrator I should be able to manage teacher and staff profiles.
• As Administrator I should be able to send notices and announcements to all users.
• As Administrator I should be able to manage admissions and enrollment processes.
• As Administrator I should be able to track inventory and library resources.

As Teacher:

• As Teacher I should be able to mark student attendance.
• As Teacher I should be able to input and manage grades/marks for students.
• As Teacher I should be able to create and update class timetables.
• As Teacher I should be able to communicate with students and parents via messages.

As Student:

• As Student I should be able to view my attendance records.
• As Student I should be able to access my grades and academic progress.
• As Student I should be able to view my timetable and upcoming classes.
• As Student I should be able to receive notices and messages from teachers and administrators.

As Parent:

• As Parent I should be able to monitor my child’s attendance and academic progress.
• As Parent I should be able to pay fees and view payment history.
• As Parent I should be able to communicate with teachers and administrators.

4. User Personas

Administrator

• Role: Manages overall school operations, including staff, finances, and resources.
• Needs: Comprehensive control over all system functionalities.

Teacher

• Role: Educates students, manages classroom activities, and communicates with parents.
• Needs: Tools for attendance, grading, scheduling, and communication.

Student

• Role: Learns and interacts with the school system for academic progress.
• Needs: Access to grades, attendance, timetable, and notices.

Parent

• Role: Monitors their child’s academic and financial activities.
• Needs: Tools for tracking progress, paying fees, and communicating with school staff.

5. Visuals Colors and Theme

Color Palette

The mint-school project will feature a fresh and vibrant color palette that reflects the energy and optimism of education:

• Background: #F5F9FC (Soft Sky Blue)
• Surface: #FFFFFF (Pure White)
• Text: #2C3E50 (Deep Navy Blue)
• Accent: #27AE60 (Mint Green)
• Muted Tones: #BDC3C7 (Light Gray)

This palette ensures a clean, professional, and approachable aesthetic suitable for educational institutions.

6. Signature Design Concept

Interactive Chalkboard Homepage
The homepage of mint-school will feature an animated, interactive chalkboard design. Upon landing, users will see a virtual chalkboard with hand-drawn animations that mimic chalk writing and erasing. Key sections of the website (e.g., Attendance, Grades, Timetable) will appear as clickable chalk-drawn icons.

• Animations: Chalk particles will scatter as users hover over icons, and clicking an icon will trigger a smooth transition where the chalkboard "wipes clean" and reveals the selected section.
• Transitions: Subtle chalk-dust effects will accompany page transitions, creating a tactile and engaging experience.
• Micro-interactions: Users can "draw" on the chalkboard using their cursor, adding a playful element to the design.

This concept combines nostalgia with modern interactivity, making the homepage unforgettable and fun to use.

7. Non-Functional Requirements

• The system must support at least 10,000 concurrent users.
• Response time for any action should not exceed 2 seconds.
• The system must comply with Indian data protection laws.
• The platform should be accessible on both web and mobile devices.
• The system must support multi-language functionality, with English and Hindi as defaults.

8. Tech Stack

Frontend

• React for Web
• React Native for Mobile App

Backend

• Python
• FastAPI

Database

• MySQL or MariaDB (preferred for RDBMS)
• MongoDB for NoSQL storage
• Alembic for database migrations

AI Models

• GPT 5.2 for user-friendly responses
• Claude 4.5 Opas for academic or coding work
• Gemini 3 Pro for friendly responses
• Google Nano Banana for image generation

AI Tools

• Litellm for LLM Routing
• Langchain

Local Orchestration

• Docker
• docker-compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

• The system assumes users have access to stable internet connections.
• The system will primarily target schools in India, with locale-specific defaults.
• Budget constraints may limit the use of certain advanced AI features initially.
• The system will be scalable to accommodate future growth and additional features.

10. Glossary

• RDBMS: Relational Database Management System.
• NoSQL: Non-relational database system for storing unstructured data.
• LLM: Large Language Model, used for AI-driven responses.
• IST: Indian Standard Time.
• Alembic: A database migration tool for Python.

This document provides a comprehensive overview of the mint-school project, ensuring all requirements are clearly defined and aligned with Mahmood Saiyed's vision.