RAMAI System Requirements Document

Introduction

Welcome to the System Requirements Document for the RAMAI project, specifically focusing on the "CodePilot AI" application. This document outlines the comprehensive system requirements for developing an all-in-one AI assistant tailored for CSE students globally. The application aims to provide a futuristic, premium experience with a focus on AI-powered tools, modern UI design, and responsive functionality.

System Overview

The "CodePilot AI" application is designed to be a comprehensive tool for CSE students, offering a range of features from AI coding assistance to productivity tools. The system will leverage advanced AI models to provide intelligent support and guidance across various academic and career-related activities. The application will be accessible via web and mobile platforms, ensuring a seamless user experience with a focus on modern design aesthetics and interactive elements.

Functional Requirements

• As a CSE Student, I should be able to use an AI Coding Assistant to detect errors, explain code, and suggest optimizations.
• As a CSE Student, I should be able to generate detailed theory answers and export them as PDFs.
• As a CSE Student, I should be able to upload PDFs and generate smart notes and flashcards.
• As a CSE Student, I should be able to track my attendance and receive alerts for low attendance.
• As a CSE Student, I should be able to build a resume using AI-generated templates and suggestions.
• As a CSE Student, I should be able to explore interactive roadmaps for various CSE career paths.
• As a CSE Student, I should be able to prepare for placements with daily coding challenges and mock interviews.
• As a CSE Student, I should be able to use productivity tools like a Pomodoro timer and habit tracker.
• As a CSE Student, I should be able to use a dark mode interface with neon gradients and glassmorphism effects.

User Personas

• CSE Student: The primary user who utilizes the app for academic assistance, career preparation, and productivity enhancement.
• Admin: Manages user accounts, oversees app functionality, and ensures smooth operation.

Visuals Colors and Theme

• primary: #0A0F29 (Deep Midnight Blue)
• primary_light: #1C2A48 (Lighter Midnight Blue)
• secondary: #FF6F61 (Coral)
• accent: #00FFAB (Neon Green)
• highlight: #FFD700 (Gold)
• bg: #121212 (Dark Background)
• surface: rgba(255, 255, 255, 0.1) (Glassmorphism Effect)
• text: #FFFFFF (White)
• text_muted: #B0B0B0 (Muted Gray)
• border: rgba(255, 255, 255, 0.2) (Subtle White)

Signature Design Concept

The "CodePilot AI" homepage will feature an interactive galaxy map where each star represents a feature or section of the app. Users can click on a star to open a task card, drag to rotate the cluster, and hover to highlight connections between features. This concept will be brought to life using @react-three/fiber and @react-three/drei for 3D interactions, creating an immersive and engaging first impression. The galaxy map will be complemented by smooth animations and transitions powered by gsap for a seamless user experience.

Interaction Model & Motion Direction

The landing page will employ a "parallax" interaction model, creating a layered depth effect as users scroll through the content. Decorative layers, such as atmospheric blobs and particle fields, will move at different speeds, enhancing the storytelling aspect of the app. Internal pages, like the dashboard and settings, will adopt a "static" model to prioritize layout clarity and reading speed.

Non-Functional Requirements

• The application must support high availability and scalability to accommodate a global user base.
• The system should ensure data security and privacy, adhering to international standards.
• The app must be responsive, providing a consistent experience across web and mobile platforms.

Tech Stack

• Frontend: React for Web, React Native for mobile app
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• AI Models: GPT 5.4 for user-friendly responses, Claude 4.6 Opas for academic work
• AI Tools: Litellm for LLM Routing, Langchain
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

Assumptions and Constraints

• The application will primarily target CSE students but can be adapted for other engineering disciplines.
• The app will require internet connectivity for AI-powered features and data synchronization.
• The design and functionality must adhere to accessibility standards to ensure inclusivity.

Glossary

• AI Coding Assistant: A tool that helps students with coding tasks by providing error detection, code explanations, and optimizations.
• Glassmorphism: A design style that uses frosted glass-like effects for UI elements.
• Parallax: An interaction model where background elements move at different speeds than foreground content, creating a sense of depth.
• Pomodoro Timer: A time management tool that breaks work into intervals, traditionally 25 minutes in length, separated by short breaks.

This document provides a comprehensive overview of the system requirements for the "CodePilot AI" application, ensuring a clear roadmap for development and design.