System Requirements Document (SRD)

fiery-teachers

1. Introduction

The fiery-teachers project is a digital classroom management system designed to streamline communication and resource sharing between teachers and students. This system aims to simplify classroom management, reduce dependency on paper, and enhance the overall teaching and learning experience.

This document outlines the system requirements for fiery-teachers, including functional and non-functional requirements, user personas, visual design elements, and technical specifications.

The project is tailored for Jeet Marvaniya, based in India, and considers locale-specific defaults such as IST (Indian Standard Time) and INR (Indian Rupee) for any financial transactions or time-based functionalities.

2. System Overview

fiery-teachers is a web and mobile application that enables teachers to manage their classrooms digitally. The system provides tools for creating and sharing notices, uploading and managing study materials, and facilitating real-time communication.

Key features include:

• Real-time updates for notices and study materials.
• Push notifications for new content.
• Offline caching for previously loaded data.
• A simple, intuitive user interface for both teachers and students.

The system is designed to be scalable, secure, and user-friendly, leveraging modern technologies like React, FastAPI, and MySQL.

3. Functional Requirements

Teacher Features

• As a Teacher, I should be able to register and log in using my email and password.
• As a Teacher, I should be able to reset my password via email.
• As a Teacher, I should be able to manage my class with a unique 6-digit class code.
• As a Teacher, I should be able to add, edit, and delete notices in real-time.
• As a Teacher, I should be able to upload, edit (details only), and delete PDFs with titles, subjects, and chapters.
• As a Teacher, I should see a progress bar while uploading PDFs.

Student Features

• As a Student, I should be able to join a class using my name and a 6-digit class code.
• As a Student, I should be able to view all notices in real-time, along with their dates.
• As a Student, I should receive push notifications for new notices.
• As a Student, I should be able to view and download PDFs, with a page counter displayed in the in-app viewer.
• As a Student, I should receive push notifications for new PDFs.

4. User Personas

Teacher

• Primary Role: Classroom manager and content creator.
• Key Actions: Register, log in, manage classes, create and share notices, upload study materials.
• Tech Proficiency: Moderate to high.

Student

• Primary Role: Content consumer and learner.
• Key Actions: Join classes, view notices, download and read study materials.
• Tech Proficiency: Low to moderate.

5. Visuals Colors and Theme

Color Palette

The fiery-teachers project will use a vibrant and professional color palette to distinguish between teacher and student interfaces while maintaining a cohesive design.

• Background: #F5F5F5 (Light Gray)
• Surface: #FFFFFF (White)
• Text: #333333 (Dark Gray)
• Accent: #FF5722 (Fiery Orange)
• Muted Tones: #BDBDBD (Muted Gray)

6. Signature Design Concept

The "Interactive Chalkboard" Landing Page

The homepage of fiery-teachers will feature an interactive chalkboard design. The chalkboard will act as the central navigation hub, with different sections of the app represented as "chalk drawings" on the board.

• Animations:

  • When the user hovers over a section (e.g., "Notices" or "PDFs"), the chalk drawing will animate as if being drawn in real-time.
  • Clicking on a section will trigger a smooth transition, with the chalkboard erasing itself and revealing the selected page.

• Micro-interactions:

  • A subtle "chalk dust" effect will appear when users interact with elements.
  • The cursor will change to a piece of chalk when hovering over interactive elements.

• Color Shifts:

  • The chalkboard background will dynamically change shades based on the time of day (e.g., lighter during the day, darker at night).

This design will create a memorable first impression and reinforce the educational theme of the project.

7. Non-Functional Requirements

• Performance: The system should handle up to 1,000 concurrent users with minimal latency.
• Scalability: The architecture should support future expansion, including additional user roles or features.
• Security: All user data must be encrypted in transit and at rest.
• Localization: The system should support Indian locale settings, including IST and INR.
• Accessibility: The UI should comply with WCAG 2.1 Level AA standards.

8. Tech Stack

Frontend

• React for web applications.
• React Native for mobile applications.

Backend

• Python with FastAPI for API development.

Database

• MySQL for relational data storage, with Alembic for migrations.

AI Models

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

AI Tools

• LangChain for AI workflow orchestration.

Orchestration

• Docker and docker-compose for local development.
• Kubernetes for server-side orchestration.

9. Assumptions and Constraints

Assumptions

• Teachers and students will have access to smartphones or computers with internet connectivity.
• The system will primarily be used in Indian educational institutions.

Constraints

• The system must comply with Indian data protection laws.
• Push notifications require user consent and device compatibility.

10. Glossary

• Class Code: A unique 6-digit code used to identify a class.
• PDF: Portable Document Format, used for sharing study materials.
• Push Notification: A message sent to a user's device to notify them of new content.
• WCAG: Web Content Accessibility Guidelines, a set of standards for making web content accessible to people with disabilities.