System Requirements Document (SRD)

Project Name: bright-teacher

1. Introduction

The bright-teacher project is an innovative attendance management system designed to simplify and streamline the process of recording attendance for teachers and students. This system leverages real-time session codes, GPS location tracking, and duplicate entry prevention to ensure accurate and transparent attendance records.

This document outlines the system requirements for the bright-teacher project, focusing on the Minimum Viable Product (MVP) scope while also considering future production enhancements. The system is tailored to meet the needs of teachers and students in India (IN), ensuring locale-specific considerations such as numeric session codes and GPS-based location tracking to prevent proxy attendance.

2. System Overview

The bright-teacher system is a web-based application that facilitates attendance management through the following core functionalities:

• Teachers can generate a unique numeric session code for each attendance session.
• Students can mark their attendance by entering the session code and their registration number.
• GPS location data is captured during attendance marking to ensure authenticity and prevent proxies.
• Duplicate entries are blocked to maintain data integrity.
• Selective re-run capability allows users to regenerate the System Requirements Document (SRD) on demand.

The MVP will simulate these functionalities within a single browser tab using in-memory state management. Future production versions will include backend integration, authentication, and advanced features like geofencing and attendance export.

3. Functional Requirements

Teacher Flow

• As a Teacher, I should be able to select "Teacher" and start a session.
• As a Teacher, I should be able to generate a random 6-digit numeric session code.
• As a Teacher, I should see a 2-minute countdown timer and progress bar indicating the session code's validity.
• As a Teacher, I should see a live attendance log updating as students mark their attendance.

Student Flow

• As a Student, I should be able to select "Student" and enter my registration number and session code.
• As a Student, I should be prompted to share my GPS location when marking attendance.
• As a Student, I should not be able to mark attendance more than once using the same registration number.

MVP Scope

• As a User, I should be able to simulate the teacher and student flows within the same browser tab.
• As a User, I should see the session code and attendance data managed in-memory for the MVP.
• As a User, I should see the 2-minute session expiry enforced client-side.
• As a User, I should be able to trigger a selective re-run to regenerate the System Requirements Document (SRD).

4. User Personas

Teacher

• Role: Initiates attendance sessions and monitors attendance logs.
• Needs: Simple session code generation, real-time attendance updates, and future capabilities like exporting attendance data.

Student

• Role: Marks attendance by entering session codes and registration numbers.
• Needs: Easy access to attendance marking, assurance of data privacy, and prevention of proxy attendance.

5. Visuals Colors and Theme

Color Palette

The bright-teacher project will use a vibrant and professional color palette to reflect its educational purpose while maintaining a modern aesthetic:

• Background: #F4F8FB (light blue-gray for a clean and calming look)
• Surface: #FFFFFF (pure white for cards and input fields)
• Text: #2C3E50 (deep navy for high readability)
• Accent: #1ABC9C (vivid teal for interactive elements like buttons and links)
• Muted Tones: #95A5A6 (soft gray for secondary information and disabled states)

6. Signature Design Concept

The bright-teacher homepage will feature an interactive chalkboard interface.

Key Features:

• Chalkboard Animation: The homepage will resemble a digital chalkboard, with text and icons appearing as if written in real-time with chalk.
• Interactive Session Code Generator: Teachers can "write" on the chalkboard to generate session codes, with animations mimicking chalk dust.
• Student Portal Access: Students can "tap" on their section of the chalkboard to enter their registration number and session code.
• Subtle Sound Effects: Chalk-writing sounds will accompany interactions, creating an immersive experience.
• Dynamic Background: The chalkboard background will subtly shift between shades of green and black, simulating a real classroom environment.

This design will make the bright-teacher platform instantly recognizable and engaging, creating a memorable first impression for users.

7. Non-Functional Requirements

• The system must support a minimum of 100 concurrent users during peak hours.
• The session code generation and validation must occur within 1 second.
• GPS location capture must have an accuracy of at least 50 meters.
• The system must comply with data privacy regulations in India (e.g., GDPR-equivalent laws).
• The selective re-run capability must regenerate the SRD within 5 seconds of the user request.

8. Tech Stack

Frontend

• React for Web

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Tools

• Litellm for LLM Routing

Local Orchestration

• Docker
• docker-compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

Assumptions

• Teachers and students will have access to devices with modern web browsers.
• GPS functionality will be available and enabled on student devices.
• Numeric session codes will be easier for users to input and remember.

Constraints

• The MVP will not include backend integration; all data will be managed in-memory.
• The system will rely on browser-native geolocation APIs, which may vary in accuracy.
• The selective re-run capability will be limited to regenerating the SRD document only.

10. Glossary

• MVP: Minimum Viable Product, the simplest version of the system that delivers core functionalities.
• Session Code: A unique 6-digit numeric code generated by the teacher for each attendance session.
• GPS: Global Positioning System, used to capture the location of students marking attendance.
• Geofencing: A feature that restricts attendance marking to a specific geographic area.
• Selective Re-run Capability: A feature allowing users to regenerate the System Requirements Document (SRD) on demand.

This updated SRD incorporates the new requirement for selective re-run capability while maintaining the original structure and intent of the bright-teacher project. Let me know if there are any additional updates or refinements you'd like, Reeba!