System Requirements Document (SRD)

Project Name: starry-hello

1. Introduction

The starry-hello project is a web-based platform designed to facilitate quiz and exam-taking for diverse user groups, including students, teachers, and companies. With the increasing demand for online learning and assessments, this platform aims to provide a seamless and efficient experience for users in India and beyond.

This document outlines the system requirements for the starry-hello project, ensuring clarity and alignment with the goals envisioned by Shasank Dixit.

2. System Overview

The starry-hello platform will serve as a comprehensive tool for conducting quizzes and exams. It will cater to three primary user personas: students, teachers, and administrators. The system will support features such as user registration, multiple question types, timed exams, automated grading, and role-specific dashboards.

The platform will prioritize user-friendly design, scalability, and security to ensure a smooth experience for all stakeholders. Locale-specific defaults, such as Indian Standard Time (IST) and INR currency for any payment-related features, will be incorporated.

3. Functional Requirements

Story Points

• As a Student, I should be able to register and log in to the platform.
• As a Student, I should be able to take quizzes and exams with different question types (MCQs, essays, etc.).
• As a Student, I should be able to view my scores and feedback after completing an exam.
• As a Teacher, I should be able to create quizzes and exams with customizable question types.
• As a Teacher, I should be able to set time limits for exams.
• As a Teacher, I should be able to grade essay-type questions manually.
• As a Teacher, I should be able to view analytics on student performance.
• As an Admin, I should be able to manage user accounts (students and teachers).
• As an Admin, I should be able to monitor platform activity and generate reports.
• As a Company, I should be able to conduct assessments for recruitment purposes.

4. User Personas

1. Student

• Description: Learners who use the platform to take quizzes and exams.
• Key Needs: Easy registration, intuitive exam interface, score visibility, and feedback.

2. Teacher

• Description: Educators who create and manage quizzes and exams for students.
• Key Needs: Tools for creating exams, grading, and analyzing student performance.

3. Admin

• Description: Platform administrators responsible for managing users and system operations.
• Key Needs: User account management, activity monitoring, and reporting.

4. Company Representative

• Description: HR professionals or recruiters conducting assessments for hiring.
• Key Needs: Customizable exams, candidate performance analytics, and secure data handling.

5. Visuals Colors and Theme

Color Palette

The starry-hello platform will adopt a celestial theme inspired by the night sky, reflecting the project's name.

• Background: #0D1B2A (Deep Midnight Blue)
• Surface: #1B263B (Starlit Navy)
• Text: #E0E1DD (Soft Moonlight White)
• Accent: #FF7F50 (Coral Starburst)
• Muted Tones: #778DA9 (Twilight Gray)

6. Signature Design Concept

Concept: Interactive Galaxy Map Homepage

The homepage of starry-hello will feature an interactive galaxy map where each star represents a feature or section of the platform.

Key Features:

• Visuals: A dynamic, animated galaxy background with twinkling stars and subtle nebula effects.
• Interaction: Users can hover over stars to reveal tooltips describing features (e.g., "Take a Quiz," "Create an Exam"). Clicking a star zooms into that section.
• Transitions: Smooth zoom-in and zoom-out animations with a parallax effect for depth.
• Micro-Interactions: Stars pulsate gently when hovered over, creating a sense of liveliness.
• Color Shifts: The galaxy background subtly changes hues based on the time of day (e.g., warmer tones in the morning, cooler tones at night).

This design will make the platform instantly memorable and engaging, aligning with the celestial theme of starry-hello.

7. Non-Functional Requirements

• Scalability: The platform must support up to 100,000 concurrent users.
• Security: Implement robust authentication and encryption mechanisms to protect user data.
• Performance: Ensure response times under 2 seconds for all major actions.
• Accessibility: Comply with WCAG 2.1 standards for accessibility.
• Localization: Support Indian Standard Time (IST) and INR currency for payment-related features.

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
• Claude 4.6 Opas for academic or coding work

AI Tools

• Litellm for LLM Routing
• Langchain

Local Orchestration

• Docker
• docker-compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

Assumptions

• Users will primarily access the platform via web browsers.
• Teachers and companies will have basic familiarity with online tools.
• The platform will initially target users in India.

Constraints

• The system must comply with Indian data protection laws.
• The platform must be optimized for low-bandwidth environments.

10. Glossary

• MCQ: Multiple Choice Questions.
• IST: Indian Standard Time.
• WCAG: Web Content Accessibility Guidelines.
• LLM: Large Language Model.
• Docker: A tool for containerizing applications.
• Kubernetes: A system for automating deployment, scaling, and management of containerized applications.