Green-Bot System Requirements Document

Introduction

The project, Green-Bot, aims to create an educational mobile application called Circuit Quest. This app is designed to teach electronics through interactive lessons, games, quizzes, and virtual circuit-building. The goal is to make learning electronics engaging and accessible, similar to language learning apps like Duolingo, while providing practical skills through interactive experiments and real-world projects.

System Overview

Circuit Quest is targeted at students aged 13–25, including high school students, diploma students, engineering students, and beginners interested in electronics. It is also suitable for hobbyists, makers, and anyone interested in Arduino, robotics, and embedded systems. The app will provide a personalized learning experience with multiple user roles, including Student, Hobbyist/Maker, Teacher, School/College, and Parent. The app will feature a world-based learning path, interactive lessons, mini-games, quizzes, a virtual circuit simulator, and an AI tutor.

Functional Requirements

• As a Student, I should be able to follow a guided learning path from beginner to advanced levels.
• As a Student, I should be able to complete daily lessons, quizzes, and challenges.
• As a Student, I should be able to earn XP, coins, badges, and maintain streaks.
• As a Student, I should be able to track my progress and receive certificates.
• As a Student, I should be able to engage in project-based learning with increasing difficulty.
• As a Hobbyist/Maker, I should be able to learn at my own pace.
• As a Hobbyist/Maker, I should be able to access a project library and tutorials.
• As a Hobbyist/Maker, I should be able to build circuits in the virtual lab.
• As a Hobbyist/Maker, I should be able to explore Arduino, ESP32, robotics, and IoT projects.
• As a Teacher, I should be able to create classrooms and invite students.
• As a Teacher, I should be able to assign lessons, quizzes, and projects.
• As a Teacher, I should be able to track student progress and performance.
• As a Teacher, I should be able to host live quiz competitions.
• As a Teacher, I should be able to view analytics and export reports.
• As a School/College, I should be able to manage multiple classrooms.
• As a School/College, I should be able to monitor overall student engagement.
• As a School/College, I should be able to access institution-wide dashboards.
• As a School/College, I should be able to provide premium access to students.
• As a School/College, I should be able to organize coding and electronics competitions.
• As a Parent (future feature), I should be able to monitor my child's learning progress.
• As a Parent (future feature), I should be able to view completed lessons and achievements.
• As a Parent (future feature), I should be able to receive weekly progress reports.
• As a Parent (future feature), I should be able to set learning goals and reminders.
• As a User, I should be able to authenticate with different roles (Student, Hobbyist, Teacher, School/College, Parent).
• As a User, I should be able to interact with a world-based learning path with levels.
• As a User, I should be able to engage with interactive lessons featuring animations and illustrations.
• As a User, I should be able to participate in mini-games, quizzes, boss battles, and daily challenges.
• As a User, I should be able to use a virtual breadboard and circuit simulator.
• As a User, I should be able to receive assistance from an AI tutor for troubleshooting circuits.
• As a User, I should be able to track progress, earn achievements, and appear on leaderboards.
• As a User, I should be able to access a project workshop with real-world electronics projects.
• As a User, I should be able to view progress tracking, certificates, and analytics.
• As a Teacher or Institution, I should be able to use dashboards for classroom management.

User Personas

• Student: Engages in structured learning paths, earns rewards, and tracks progress.
• Hobbyist/Maker: Learns independently, accesses project libraries, and explores advanced topics.
• Teacher: Manages classrooms, assigns tasks, and tracks student performance.
• School/College: Oversees multiple classrooms and student engagement.
• Parent: (Future Feature) Monitors child's progress and sets learning goals.

Core User Flows

• Student logs in -> selects lesson -> completes interactive lesson -> earns XP and badges -> progresses to next level.
• Hobbyist accesses project library -> selects a project -> builds circuit in virtual lab -> tests and modifies circuit.
• Teacher creates classroom -> invites students -> assigns lessons and quizzes -> tracks student progress -> exports reports.
• School/College manages classrooms -> monitors student engagement -> organizes competitions -> provides premium access.
• Parent (future feature) logs in -> views child's progress -> sets learning goals -> receives weekly reports.

Visuals Colors and Theme

• primary: #1E90FF (Dodger Blue)
• primary_light: #63B8FF (Light Sky Blue)
• secondary: #FF6347 (Tomato)
• accent: #32CD32 (Lime Green)
• highlight: #FFD700 (Gold)
• bg: #F0F8FF (Alice Blue)
• surface: rgba(255, 255, 255, 0.9)
• text: #000000 (Black)
• text_muted: #696969 (Dim Gray)
• border: rgba(0, 0, 0, 0.1)

Signature Design Concept

The Circuit Quest app will feature an interactive, animated circuit board as the landing page. Users will navigate through a virtual circuit, where each component represents a different section of the app. Hovering over a component will animate it, providing a brief description of the section it represents. Clicking on a component will zoom into that section, transitioning smoothly with animations powered by framer-motion. The circuit board will dynamically change colors based on the user's progress, creating a visually engaging and interactive experience.

Interaction Model & Motion Direction

The landing page will utilize a parallax interaction model, with layered depth effects as users scroll. Decorative elements like circuit traces and component animations will move at different speeds, creating a sense of depth and immersion. Internal pages will feature animated interactions, with smooth transitions and hover effects to enhance user engagement.

Non-Functional Requirements

• The app must support both Android and iOS platforms.
• The app should provide a responsive design for various screen sizes.
• The app should ensure data privacy and secure user authentication.
• The app should be scalable to accommodate future features and user growth.
• The app should provide a seamless user experience with minimal load times.

Tech Stack

• Frontend: React Native for mobile app development.
• Backend: Python with FastAPI for server-side logic.
• Database: MongoDB for flexible data storage.
• AI Models: GPT 5.4 for user-friendly responses and AI tutoring.
• AI Tools: Langchain for AI integration.
• Orchestration: Docker for local development and Kubernetes for server-side orchestration.

Assumptions and Constraints

• The app will require internet connectivity for full functionality.
• The app will be designed with a focus on educational content and user engagement.
• The app will need to comply with educational standards and data protection regulations.

Glossary

• XP: Experience Points, a measure of user progress.
• AI Tutor: An artificial intelligence feature that assists users with learning and troubleshooting.
• Virtual Lab: A simulated environment for building and testing electronic circuits.
• Parallax: A visual effect where background images move slower than foreground images, creating depth.
• Framer-motion: A library for creating animations in React applications.