System Requirements Document (SRD) for bright-hii

1. Introduction

The bright-hii project is a QR code-based attendance application designed to streamline attendance tracking for various user groups. This document outlines the system requirements, functional and non-functional specifications, and design concepts for the application. The goal is to create a user-friendly, efficient, and visually appealing platform that meets the needs of its users.

This document has been tailored for Vipin Nagar, based in India, and considers locale-specific defaults such as time zones (IST), currency (INR), and user preferences.

2. System Overview

The bright-hii application will allow users to scan QR codes to mark attendance. The system will cater to multiple user personas, including administrators, employees, and guests. The app will ensure secure, real-time attendance tracking and provide analytics for administrators.

The platform will be accessible via both web and mobile applications, ensuring flexibility and ease of use. The backend will leverage modern technologies for scalability and reliability, while the frontend will focus on an intuitive user experience.

3. Functional Requirements

Story Points:

• As an Admin, I should be able to generate unique QR codes for each event or session.
• As an Admin, I should be able to view and download attendance reports in CSV format.
• As a User, I should be able to scan a QR code to mark my attendance.
• As a User, I should receive a confirmation message after successfully marking attendance.
• As an Admin, I should be able to set time limits for QR code validity.
• As a Guest, I should be able to scan a QR code without needing to log in.
• As an Admin, I should be able to manage user roles and permissions.

4. User Personas

1. Admin

• Role: Manages events, generates QR codes, and monitors attendance.
• Responsibilities: Setting up sessions, managing user roles, and analyzing attendance data.

2. User

• Role: Regular attendee (e.g., employee or student).
• Responsibilities: Scanning QR codes to mark attendance and receiving confirmation.

3. Guest

• Role: Occasional attendee without a registered account.
• Responsibilities: Scanning QR codes for attendance without logging in.

5. Visuals Colors and Theme

Color Palette:

• Background: #F5F9FF (Soft Sky Blue)
• Surface: #FFFFFF (Pure White)
• Text: #2C3E50 (Deep Navy Blue)
• Accent: #FF6F61 (Warm Coral)
• Muted Tones: #B0BEC5 (Soft Gray)

This palette reflects a clean, professional, and modern aesthetic, suitable for an attendance application.

6. Signature Design Concept

Dynamic QR Code Dashboard with Real-Time Animations

The homepage will feature a dynamic QR code dashboard that visually represents attendance activity in real time. The QR codes will appear as animated tiles that "pulse" gently when active.

Key features:

• Interactive QR Code Tiles: Each tile represents an event/session. Hovering over a tile will display session details (e.g., time, location, attendees).
• Real-Time Updates: As users scan QR codes, the dashboard will update live, showing the number of attendees for each session.
• Micro-Interactions: Subtle animations, such as a ripple effect when a QR code is scanned, will enhance user engagement.
• Background Animation: A soft gradient animation will flow across the background, creating a modern and dynamic feel.

This design ensures the homepage is not only functional but also visually captivating, leaving a lasting impression on users.

7. Non-Functional Requirements

• Performance: The system should handle up to 10,000 concurrent users without performance degradation.
• Scalability: The backend should support the addition of new features and increased user load.
• Security: QR codes should be encrypted to prevent unauthorized access or duplication.
• Availability: The system should maintain 99.9% uptime.
• Localization: The app should support Indian Standard Time (IST) and INR currency formats.

8. Tech Stack

Frontend:

• React for Web
• React Native for Mobile App

Backend:

• Python
• FastAPI

Database:

• MySQL (with Alembic for migrations)

AI Tools:

• GPT 5.4 for user-friendly responses
• Litellm for LLM Routing

Orchestration:

• Docker for local development
• Kubernetes for server-side orchestration

9. Assumptions and Constraints

Assumptions:

• Users will have access to smartphones or devices capable of scanning QR codes.
• Admins will have basic technical knowledge to manage the system.

Constraints:

• The app must comply with Indian data protection regulations.
• The system should operate efficiently on low-bandwidth networks.

10. Glossary

• QR Code: A machine-readable code consisting of black and white squares, used for storing information.
• Admin: A user with elevated permissions to manage the system.
• User: A registered attendee who scans QR codes to mark attendance.
• Guest: An unregistered attendee who can scan QR codes without logging in.
• IST: Indian Standard Time.
• CSV: Comma-Separated Values, a file format for storing tabular data.

End of Document