System Requirements Document (SRD)

Project Name: eagle-sketch

1. Introduction

The eagle-sketch project is a school website designed with a unique sketch theme and pencil-style colors. This creative and nostalgic design aims to engage students, educators, and parents by providing a playful yet functional platform. The website will include essential features such as assignments, student portals, and teacher dashboards, making it a comprehensive solution for modern educational needs.

This document outlines the system requirements for eagle-sketch, ensuring clarity and alignment with the vision of Prince Sakshi Kashyap from India. The design will cater to the Indian educational context, including locale-specific defaults like IST (Indian Standard Time) and INR (Indian Rupee) for any monetary references.

2. System Overview

The eagle-sketch system will serve as a digital hub for schools, offering:

• A visually engaging sketch-themed interface.
• Functional tools for students, teachers, and administrators.
• Features to manage assignments, announcements, and communication.

The system will be accessible via web and mobile platforms, ensuring ease of use for all stakeholders. The design will prioritize simplicity, creativity, and functionality, aligning with the pencil-sketch aesthetic.

3. Functional Requirements

Core Features

• As a Student, I should be able to view and submit assignments.
• As a Teacher, I should be able to upload assignments and grade submissions.
• As an Admin, I should be able to manage user accounts and monitor activity.
• As a Parent, I should be able to view my child’s progress and communicate with teachers.
• As a Guest, I should be able to view general school information like events and contact details.

Additional Features

• As a User, I should be able to access a calendar for events and deadlines.
• As a User, I should be able to view a gallery of school activities.
• As an Admin, I should be able to send announcements to all users.

4. User Personas

1. Student

• Primary user of the platform.
• Needs access to assignments, grades, and announcements.

2. Teacher

• Responsible for uploading assignments, grading, and communicating with students and parents.

3. Admin

• Manages the platform, user accounts, and overall system functionality.

4. Parent

• Monitors their child’s progress and communicates with teachers.

5. Guest

• Accesses general school information without logging in.

5. Visuals Colors and Theme

The eagle-sketch project will use a pencil-inspired color palette to align with its sketch theme. The colors will evoke creativity and nostalgia, resembling pencil drawings on paper.

Color Palette

• Background: #F5F5DC (Beige Paper)
• Surface: #D3D3D3 (Graphite Gray)
• Text: #2F4F4F (Charcoal Black)
• Accent: #FFD700 (Golden Yellow for Highlights)
• Muted Tones: #A9A9A9 (Soft Gray for Subtle Elements)

6. Signature Design Concept

The eagle-sketch homepage will resemble an interactive notebook or sketchpad.

Key Features:

1. Hand-Drawn Animations:

   • Each section of the homepage will appear as if it’s being drawn in real-time with a pencil.
   • Hover effects will mimic pencil shading, adding depth to the design.

2. Interactive Notebook Layout:

   • The homepage will be divided into "pages" of a notebook.
   • Users can "flip" through pages using a swipe or click gesture.

3. Dynamic Pencil Cursor:

   • The cursor will appear as a pencil, leaving a faint trail when moved across the screen.

4. Sketchy Icons and Fonts:

   • All icons and fonts will have a hand-drawn, sketch-like appearance.

5. Subtle Paper Texture:

   • The background will have a faint paper texture to enhance the sketch theme.

This design will create an immersive and memorable experience, making the website stand out while maintaining usability.

7. Non-Functional Requirements

• Performance: The website should load within 3 seconds on a standard broadband connection.
• Scalability: The system must support up to 10,000 concurrent users.
• Accessibility: The design will comply with WCAG 2.1 Level AA standards.
• Localization: The system will support Indian locale defaults, including IST and INR.
• Security: User data will be encrypted, and the system will comply with GDPR and local data protection laws.

8. Tech Stack

Frontend

• React for Web
• React Native for Mobile App

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Models

• GPT 5.4 for user-friendly responses
• Google Nano Banana for image generation

AI Tools

• Langchain
• Litellm for LLM Routing

Orchestration

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

9. Assumptions and Constraints

Assumptions

• Users will have access to stable internet connections.
• The majority of users will access the system via mobile devices.
• The school will provide content and manage user accounts.

Constraints

• The design must align with the pencil-sketch theme.
• The system must be deployable within six months.
• Budget constraints may limit the use of advanced AI features.

10. Glossary

• IST: Indian Standard Time
• INR: Indian Rupee
• WCAG: Web Content Accessibility Guidelines
• GDPR: General Data Protection Regulation
• LLM: Large Language Model