System Requirements Document (SRD) for garnet-platform

1. Introduction

The garnet-platform is an ambitious and innovative project envisioned by Sanjana Mathe to create a comprehensive learning platform catering to students from LKG to postgraduate levels. This platform aims to revolutionize education by blending interactive tools, gamification, and storytelling animations to make learning engaging, inclusive, and personalized. By leveraging cutting-edge technologies and creative design concepts, garnet-platform aspires to set a new standard for educational systems globally, with a focus on accessibility and adaptability for learners in India and beyond.

2. System Overview

The garnet-platform is a digital education ecosystem designed to provide a seamless learning experience for students across all age groups. The platform will feature:

• A progressive content delivery system with scroll-based storytelling animations.
• Interactive tools such as quizzes, flashcards, and smart notes generators.
• Gamification elements like badges, leaderboards, and achievements to motivate learners.
• A personalized dashboard for tracking progress and managing learning paths.
• A new education system that integrates personalized learning paths, collaborative tools, and problem-solving approaches to redefine traditional education.

The platform will be accessible via web and mobile applications, ensuring a consistent and engaging user experience across devices.

3. Functional Requirements

• As a User, I should be able to progressively explore content section by section as I scroll.
• As a User, I should experience an immersive intro sequence featuring a lion mascot that transforms into a cartoon character.
• As a User, I should be able to navigate through subject-specific worlds (e.g., Science Safari, Geography Mountains).
• As a User, I should be able to access rhymes and songs with lyrics, animations, and play buttons.
• As a User, I should be able to use interactive learning tools like Smart Notes Generator, Flashcards, and Quiz Generator.
• As a User, I should be able to view my progress and achievements on a personalized dashboard.
• As a User, I should be motivated by gamification elements such as stars, badges, and leaderboards.
• As a User, I should experience smooth animations and transitions while navigating the platform.
• As an Admin, I should be able to manage content, track user engagement, and update learning tools.
• As a Developer, I should be able to integrate a new education system that supports personalized learning paths, collaborative tools, and problem-solving approaches.

4. User Personas

1. Student

• Age Range: 3–25 years
• Goals: Learn interactively, track progress, and earn achievements.
• Needs: Engaging content, personalized learning paths, and gamified experiences.

2. Parent

• Age Range: 25–50 years
• Goals: Monitor child’s progress and ensure quality education.
• Needs: Dashboard access, progress reports, and learning recommendations.

3. Educator

• Age Range: 25–60 years
• Goals: Provide quality content and track student performance.
• Needs: Content management tools, analytics, and collaborative features.

4. Admin

• Age Range: 25–60 years
• Goals: Manage platform operations and ensure smooth functionality.
• Needs: Administrative tools, user management, and content control.

5. Visuals Colors and Theme

Unique Color Palette for garnet-platform:

• Background: #F5F7FA (Soft Cloud White)
• Surface: #FFFFFF (Pure White)
• Text: #2E2E3A (Deep Charcoal)
• Accent: #FF6F61 (Vibrant Coral)
• Muted Tones: #A3B4C4 (Calm Blue-Gray)

This palette reflects a balance of professionalism and playfulness, suitable for an educational platform catering to a wide age range.

6. Signature Design Concept

"The Learning Adventure World"

The homepage of garnet-platform will transport users into an interactive adventure world. Upon loading, users will experience:

1. Intro Sequence:

   • A dark screen with soft music sets the mood.
   • A realistic lion appears in the distance, walking toward the viewer.
   • The lion leaps forward, roaring, causing the screen to shake slightly.
   • The lion transforms into a cute cartoon mascot, symbolizing the transition from serious to fun learning.

2. Scroll Storytelling Animations:

   • As users scroll, sections reveal themselves with fade-in, slide-up, and parallax animations.
   • Each subject world (e.g., Science Safari, Geography Mountains) is represented by a unique animated mascot and theme.

3. Interactive Elements:

   • Cards flip and slide into view, inviting users to explore rhymes, tools, and dashboards.
   • Gamification elements sparkle and pop, creating a sense of achievement.

4. Dynamic Backgrounds:

   • Cartoon skies with floating clouds and sparkles create a whimsical atmosphere.
   • Backgrounds subtly change colors and animations based on the section.

This design ensures users feel like they are embarking on a magical learning journey, keeping them engaged and curious.

7. Non-Functional Requirements

• The platform must support high performance and smooth animations across devices.
• The system should be scalable to accommodate a growing user base.
• Ensure accessibility compliance (WCAG 2.1) for users with disabilities.
• Provide multi-language support for diverse user demographics.
• Ensure data security and privacy compliance (e.g., GDPR, Indian IT Act).

8. Tech Stack

Frontend

• React (Web)
• Next.js (Server-side rendering)
• TailwindCSS (Styling)
• React Three Fiber (3D animations)
• Framer Motion and GSAP (Advanced animations)
• Lenis (Smooth scrolling)

Backend

• Python with FastAPI (API development)

Database

• MySQL (Primary RDBMS with Alembic for migrations)
• MongoDB (NoSQL for unstructured data)

AI Models

• GPT 5.4 (User-friendly responses)
• Claude 4.6 Opas (Academic and coding assistance)
• Google Nano Banana (Image generation)

AI Tools

• Langchain and Litellm (LLM routing)

Orchestration

• Docker and docker-compose (Local)
• Kubernetes (Server-side)

9. Assumptions and Constraints

• The platform will primarily target users in India, with INR as the default currency and IST as the default timezone.
• Internet connectivity is required for accessing platform features.
• The platform will support modern browsers and mobile devices.

10. Glossary

• LKG: Lower Kindergarten
• RDBMS: Relational Database Management System
• NoSQL: Non-relational database
• AI: Artificial Intelligence
• WCAG: Web Content Accessibility Guidelines
• IST: Indian Standard Time
• INR: Indian Rupee
• LLM: Large Language Model
• Gamification: The use of game-like elements in non-game contexts to engage users.