System Requirements Document (SRD)

Project Name: swift-student

1. Introduction

The swift-student project is a comprehensive student result management system designed to simplify the process of managing and accessing academic results. Developed with the needs of educational institutions in India in mind, this system will cater to schools, colleges, and other academic organizations. It aims to provide a seamless experience for administrators, teachers, and students by supporting file uploads, result processing, and online result display.

This document outlines the system requirements for swift-student, ensuring clarity and alignment with the project's goals.

2. System Overview

The swift-student system will serve as a centralized platform for managing student results. It will allow administrators and teachers to upload student data and results in various file formats, such as CSV and Excel, for bulk processing. Students will be able to access their results online and download them in PDF format.

Key features include:

• File upload and processing for bulk result entry.
• Online result display for students.
• Role-based access for administrators, teachers, and students.
• Support for multiple file formats, including CSV, Excel, and PDF.

The system will be tailored to the Indian education system, incorporating locale-specific defaults like IST timezone and INR currency for any financial transactions.

3. Functional Requirements

Story Points:

• As Admin, I should be able to upload student data files (CSV, Excel) for bulk result processing.
• As Admin, I should be able to manage user roles (Admin, Teacher, Student).
• As Teacher, I should be able to upload individual student results manually.
• As Teacher, I should be able to view and edit uploaded results.
• As Student, I should be able to view my results online.
• As Student, I should be able to download my results in PDF format.
• As Admin, I should be able to generate reports for overall student performance.
• As Admin, I should be able to set grading criteria and thresholds.
• As Teacher, I should be able to send notifications to students regarding result updates.

4. User Personas

Admin

• Description: Responsible for managing the system, uploading bulk data, and overseeing user roles and permissions.
• Key Actions: Upload files, manage roles, generate reports, set grading criteria.

Teacher

• Description: Responsible for entering and managing student results, sending notifications, and editing uploaded data.
• Key Actions: Upload individual results, edit data, send notifications.

Student

• Description: End-user accessing their results online and downloading them in PDF format.
• Key Actions: View results, download results.

5. Visuals Colors and Theme

Color Palette:

• Background: #F9F9F9 (Soft Pearl White)
• Surface: #E3F2FD (Light Sky Blue)
• Text: #212121 (Charcoal Black)
• Accent: #FF6F61 (Coral Red)
• Muted Tones: #B0BEC5 (Steel Gray)

The theme will evoke a sense of professionalism and simplicity, ensuring ease of use for all users.

6. Signature Design Concept

Concept: Interactive Result Dashboard

The homepage will feature an Interactive Result Dashboard that dynamically updates based on user roles.

Key Features:

• Admin View: A control panel with widgets for file uploads, user role management, and performance analytics.
• Teacher View: A streamlined interface for editing results and sending notifications.
• Student View: A personalized dashboard displaying their academic performance with an animated progress bar.

Visuals:

• Animations: Smooth transitions between widgets, with hover effects that highlight actionable items.
• Micro-Interactions: Clicking on a result will expand it into a detailed view with download options.
• Dynamic Background: A subtle gradient that shifts from light blue to coral red based on user activity.

This design ensures an engaging and intuitive experience, making the system memorable and easy to navigate.

7. Non-Functional Requirements

• Performance: The system should handle up to 10,000 concurrent users without degradation.
• Security: Role-based access control and encryption for sensitive data.
• Scalability: Ability to scale horizontally to accommodate increasing user base.
• Availability: 99.9% uptime guarantee.
• Localization: Support for Indian locale defaults (IST timezone, INR currency).

8. Tech Stack

Frontend

• React for Web
• React Native for Mobile App

Backend

• Python
• FastAPI

Database

• MySQL (preferred) or MariaDB for RDBMS
• MongoDB for NoSQL

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 and docker-compose for local development
• Kubernetes for server-side orchestration

9. Assumptions and Constraints

Assumptions

• Users will have basic familiarity with web and mobile applications.
• Institutions will provide data in supported file formats (CSV, Excel).
• Students will primarily access results via mobile devices.

Constraints

• The system must comply with Indian data protection laws.
• File uploads are limited to 50 MB per file.
• Internet connectivity is required for accessing the system.

10. Glossary

• CSV: Comma-Separated Values, a file format for tabular data.
• PDF: Portable Document Format, used for downloading results.
• RDBMS: Relational Database Management System, used for structured data storage.
• NoSQL: Non-relational database for flexible data storage.
• Role-Based Access Control: A security mechanism to restrict system access based on user roles.