System Requirements Document (SRD)

Project Name: Grand-Maths

1. Introduction

The Grand-Maths project aims to provide a streamlined and user-friendly platform for managing academic records, with a focus on mathematics and science subjects. This document outlines the system requirements for the project, ensuring clarity and alignment with the user's needs.

2. System Overview

The Grand-Maths system will be a web-based application designed to manage student academic records efficiently. It will allow users to input, update, and view marks for various subjects, including mathematics and science. The system will prioritize accuracy, ease of use, and adherence to the reference design provided by Aditya Gargh.

3. Functional Requirements

• As a User, I should be able to update the maths theory marks to 63.
• As a User, I should be able to update the science theory marks to 61.
• As an Admin, I should be able to manage student records, including adding, editing, and deleting entries.
• As a Guest, I should be able to view public academic records without editing privileges.

4. User Personas

4.1 Admin

• Role: Manages the system and oversees all academic records.
• Responsibilities: Add, edit, delete, and review student records.

4.2 User

• Role: A student or parent accessing their academic records.
• Responsibilities: View and update marks for specific subjects.

4.3 Guest

• Role: A visitor accessing public academic records.
• Responsibilities: View records without editing privileges.

5. Visuals Colors and Theme

Color Palette

The color palette for Grand-Maths is inspired by the reference image provided.

• Background: #F5F5F5 (Light Gray)
• Surface: #FFFFFF (White)
• Text: #333333 (Dark Gray)
• Accent: #007BFF (Bright Blue)
• Muted Tones: #CCCCCC (Soft Gray)

6. Signature Design Concept

Concept: Interactive Academic Dashboard

The homepage will feature an interactive academic dashboard that mimics a digital report card.

• Design Elements:

  • A table layout resembling a physical report card, with rows for subjects and columns for marks.
  • Editable fields for theory and practical marks, allowing users to update values directly.
  • Hover animations: When hovering over a subject row, the background subtly changes to the accent color (#007BFF).
  • Micro-interactions: Marks update with a smooth transition effect, accompanied by a confirmation popup.

• Visual Appeal:

  • Clean and minimalistic design with sharp typography.
  • Icons representing subjects (e.g., a calculator for mathematics, a beaker for science).
  • A progress bar at the top indicating the completion of academic updates.

7. Non-Functional Requirements

• The system must ensure data accuracy and integrity.
• The platform should load within 3 seconds on standard internet connections.
• The system must be compatible with modern browsers (Chrome, Firefox, Edge).
• Ensure secure access with role-based authentication.

8. Tech Stack

Frontend

• React for Web

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Models

• GPT 5.4 for user-friendly responses

AI Tools

• LangChain

Local Orchestration

• Docker
• Docker-Compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

• The system assumes that users will have basic familiarity with web applications.
• The platform will primarily cater to academic institutions in India.
• The system will not support offline functionality.

10. Glossary

• Theory Marks: Marks awarded for written examinations.
• Practical Marks: Marks awarded for practical assessments.
• Admin: A user with full access to manage the system.
• User: A student or parent accessing academic records.
• Guest: A visitor with view-only access.