Skip to content

Hassassin-10/BrainLoop_E-Learning

Repository files navigation

🧠 BrainLoop

BrainLoop is an interactive, AI-powered educational platform that integrates video-based learning, AR labs, quizzes, and a smart chatbot to enhance the personalized learning experience for students.


πŸš€ Features

  • πŸ” Secure Authentication

    • Google, Email/Password, or Barcode-based login
    • Role-based access control using Student IDs (e.g., 8918, 8946, etc.)
  • πŸŽ“ Course Management

    • View courses, mark modules as completed
    • Admins (e.g., 8918) can create, edit, and delete courses
  • πŸŽ₯ Video Learning

    • Embedded YouTube/MP4 videos (not redirected)
    • Progress tracking for each student
  • πŸ’¬ Real-time Doubt Resolution

    • Chat-based doubt asking per module
    • Doubts can be pinned and replied to in real time
    • Student-to-student chat (e.g., 8918 and 8946)
  • πŸ§ͺ Interactive AR Labs

  • πŸ’³ Payments

    • Stripe (Test Mode) integration for course purchases
    • Alternative Razorpay-like options considered
  • πŸ€– AI Chatbot

    • Persistent chatbot available on all pages
    • Positioned on the bottom-right of the screen
  • πŸ“„ Feedback System

    • Students can submit feedback per course/module
    • Feedback is linked to student ID and timestamped
  • πŸ‘€ Profile Management

    • Shows name, email, student ID
  • 🌌 3D Spline Background

    • Interactive background using Spline3D behind the landing message

🧱 Tech Stack

  • Frontend: Next.js, Tailwind CSS, TypeScript
  • Backend: Firebase (Firestore, Realtime DB, Auth)
  • 3D Graphics: Spline
  • Payment Gateway: Stripe (Test Mode)
  • Authentication: Firebase Auth + custom student ID logic

πŸ› οΈ Setup Instructions

  1. Clone the Repo

    git clone https://github.com/your-org/brainloop.git
    cd brainloop
  2. Install Dependencies

    npm install
  3. Add Firebase Config Create a .env.local and add:

    NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
    NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
    NEXT_PUBLIC_FIREBASE_DATABASE_URL=your_db_url
    NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
    NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_bucket
    NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
    NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
  4. Run the Dev Server

    npm run dev

πŸ“ Folder Structure

/src
  /app              β†’ Pages and routes
  /components       β†’ Reusable UI components
  /contexts         β†’ Auth & global state
  /data             β†’ Mock course/video data
  /services         β†’ Firebase/Firestore/Stripe logic

βœ… Admin Privileges

Only the following Student IDs can perform admin actions:

  • 8918 – Master Admin
  • 8946, 8904, STRITH23170 – Custom access (if configured)

πŸ“Έ Screenshots

Feature Screenshot
Login Page βœ… Google & Email Auth
AR Labs βœ… Interactive buttons to PhET, Falstad, etc.
Course Modules βœ… Video progress + feedback system
Chatbot βœ… Visible across all pages, fixed bottom-right
Admin Panel βœ… Add/Edit/Delete courses

πŸ§ͺ Test Payments with Stripe

Use the following test card to simulate payments:

Card: 4242 4242 4242 4242
Exp: Any future date
CVV: 123

πŸ“œ License

MIT License. Free for educational and non-commercial use.


"Unlock Your Learning Potential with BrainLoop" πŸš€

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages