sarojit049/peernode_

โ˜… 0Forks 0TypeScriptGitHub โ†—Compare

README

PeerNode

License: MIT PRs Welcome

๐ŸŽฏ Problem Statement

Students struggle to find compatible study partners, create effective study schedules, and maintain focus during exam preparation. Traditional study methods often lack personalization and collaborative elements, leading to inefficient learning and increased stress.

๐Ÿ’ก Our Solution

PeerNode is an AI-powered study collaboration platform that intelligently matches students with compatible study partners, generates personalized study plans, and provides focus-enhancing tools. Our platform transforms solitary studying into a collaborative, efficient, and enjoyable experience.

๐Ÿš€ Key Features

๐Ÿ” AI-Powered Study Partner Matching

  • Smart Matching Algorithm: Matches students based on subject, availability, study style, and exam dates
  • Transparent Explanations: Clear reasons why each match was suggested
  • Real-time Updates: Live matching as new users join

๐Ÿง  AI Study Plan Generator

  • Personalized Schedules: Day-by-day study plans tailored to your needs
  • Weak Topic Focus: Extra attention to challenging subjects
  • Optimized Breaks: Built-in rest periods for maximum retention

๐Ÿ  Real-time Study Rooms

  • Live Collaboration: Chat with study partners in real-time
  • Presence Indicators: See who's online and available
  • Secure Environment: Protected rooms for focused group study

โฐ Focus Mode

  • Pomodoro Technique: 25-minute focused sessions with 5-minute breaks
  • Motivational AI: Encouraging messages to keep you on track
  • Session Tracking: Monitor your productivity over time

๐ŸŒ™ Modern UI/UX

  • Mobile-First Design: Optimized for studying on any device
  • Dark Mode: Eye-friendly interface for long study sessions
  • Loading Skeletons: Smooth transitions during data loading
  • Empty States: Helpful guidance when no content exists

๐Ÿ›  Tech Stack

Frontend

  • React 18 with TypeScript
  • Tailwind CSS for responsive styling
  • shadcn/ui components
  • React Router for navigation
  • Lucide React icons

Backend

  • Firebase Authentication for secure user management
  • Firestore for real-time database
  • Firebase Cloud Functions (future enhancement)

AI Integration

  • Google Gemini API for intelligent matching and planning
  • Prompt Engineering for consistent, high-quality outputs

Dev Tools

  • Vite for fast development
  • ESLint & Prettier for code quality
  • Vercel for deployment

๐Ÿค– AI Usage

PeerNode leverages AI in several key areas:

  1. Study Partner Matching: Calculates compatibility scores based on multiple factors
  2. Match Explanations: Generates clear, simple-language explanations for each match
  3. Study Plan Generation: Creates personalized day-by-day schedules
  4. Focus Motivation: Provides encouraging messages during Pomodoro sessions

All AI features are designed to enhance human learning, not replace it. Our algorithms prioritize transparency and user control.

๐Ÿ“ธ Screenshots

(Placeholder for actual screenshots)

  1. Dashboard with study partner matches
  2. AI-generated study plan view
  3. Real-time study room interface
  4. Focus mode timer with motivational messages

๐ŸŽฎ Demo Instructions

  1. Clone the repository:

    git clone https://github.com/yourusername/peernode.git
    cd peernode
  2. Install dependencies:

    npm install
  3. Set up environment variables: Create a .env file with:

    VITE_FIREBASE_API_KEY=your_firebase_api_key
    VITE_GEMINI_API_KEY=your_gemini_api_key
    
  4. Run the development server:

    npm run dev
  5. Open your browser: Navigate to http://localhost:5173

๐Ÿ“ˆ Future Scope

  • Video Study Rooms: Add video conferencing for face-to-face study sessions
  • Progress Tracking: Visualize study progress and improvements over time
  • Resource Sharing: Share study materials and resources within study groups
  • Mobile App: Native mobile applications for iOS and Android
  • AI Tutor Integration: Connect with AI tutors for subject-specific help

๐Ÿ”’ Security & Privacy

  • End-to-end authentication with Firebase
  • Role-based access control for study rooms
  • Encrypted data transmission
  • GDPR-compliant data handling

๐Ÿ“„ AI Usage Disclosure

We are transparent about our AI usage:

  • Development Assistant: AI tools were used to assist with code generation, UI design suggestions, and text content
  • Human-Driven Decisions: All architectural decisions, logic implementation, and core functionality were developed by humans
  • Ethical Implementation: AI is used to enhance user experience while maintaining transparency about its role
  • User Control: Users always have control over their data and can override AI suggestions

๐Ÿ† Why PeerNode?

  1. Solves a Real Problem: Addresses genuine student pain points in academic collaboration
  2. AI with Transparency: Clear explanations for all AI-driven decisions
  3. Complete Solution: From partner matching to focus enhancement
  4. Hackathon-Ready: Clean codebase with clear documentation
  5. Scalable Architecture: Designed for future enhancements and growth

๐Ÿ™Œ Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ Get Started Today

Transform your study experience with PeerNode. Connect with compatible partners, study smarter with AI-generated plans, and stay focused with our Pomodoro timer.

Get Started Now | View Demo | Read Documentation

Contributors

sarojit049

Issues