Skip to content

Yashparmar1125/EduAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

88 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŽ“ EduAI - AI-Powered Learning Platform

React Node.js MongoDB Firebase Tailwind CSS

๐ŸŒŸ Transform your learning experience with AI-powered education.

๐Ÿ“š Overview

EduAI is a modern, AI-powered learning platform that provides personalized education experiences through interactive courses, assessments, and gamification features. Our platform combines cutting-edge technology with proven educational methodologies to create an engaging and effective learning environment..

โœจ Key Features

๐ŸŽฎ Interactive Learning

  • ๐Ÿ“บ Multimedia-rich course content
  • ๐ŸŽฏ Interactive exercises
  • ๐ŸŽจ Visual learning aids
  • ๐ŸŽต Audio-visual materials

๐Ÿค– AI-Powered Features

  • ๐Ÿง  Smart content recommendations
  • ๐Ÿ“Š Personalized learning paths
  • ๐Ÿ”„ Adaptive difficulty levels
  • ๐ŸŽฏ Performance analytics

๐Ÿ“ˆ Progress & Analytics

  • ๐Ÿ“Š Real-time progress tracking
  • ๐Ÿ“ˆ Performance metrics
  • ๐ŸŽฏ Goal setting
  • ๐Ÿ“‘ Progress reports

๐Ÿ† Gamification

  • ๐Ÿ… Achievement system
  • ๐ŸŽฎ Interactive rewards
  • ๐ŸŒŸ Point system
  • ๐Ÿ† Leaderboards

๐Ÿ› ๏ธ Tech Stack

๐Ÿ”ท Frontend Technologies
  • โš›๏ธ React 18 - UI Framework
  • โšก Vite - Build Tool
  • ๐ŸŽจ Tailwind CSS - Styling
  • ๐Ÿ”„ Redux Toolkit - State Management
  • ๐Ÿ›ฃ๏ธ React Router - Navigation
  • ๐ŸŽฏ Radix UI - UI Components
  • ๐Ÿ“Š Recharts - Data Visualization
  • ๐Ÿ”ฅ Firebase Client SDK - Backend Services
๐Ÿ”ท Backend Technologies
  • ๐ŸŸข Node.js - Runtime Environment
  • ๐Ÿš‚ Express.js - Web Framework
  • ๐Ÿƒ MongoDB - Database
  • ๐Ÿ” JWT - Authentication
  • โ˜๏ธ Cloudinary - Media Storage
  • ๐Ÿ›ก๏ธ Helmet - Security
  • ๐Ÿ”’ Rate Limiting - API Protection

๐Ÿ“ Project Structure

EduAI/
โ”œโ”€โ”€ ๐ŸŽจ Frontend/
โ”‚   โ”œโ”€โ”€ ๐Ÿ“ src/
โ”‚   โ”‚   โ”œโ”€โ”€ ๐Ÿงฉ components/
โ”‚   โ”‚   โ”œโ”€โ”€ ๐Ÿ“„ pages/
โ”‚   โ”‚   โ”œโ”€โ”€ ๐Ÿ’พ store/
โ”‚   โ”‚   โ”œโ”€โ”€ ๐Ÿ› ๏ธ utils/
โ”‚   โ”‚   โ””โ”€โ”€ โš›๏ธ App.jsx
โ”‚   โ”œโ”€โ”€ ๐ŸŒ public/
โ”‚   โ””โ”€โ”€ ๐Ÿ“ฆ package.json
โ”œโ”€โ”€ โš™๏ธ Backend/
โ”‚   โ”œโ”€โ”€ ๐Ÿ“ src/
โ”‚   โ”‚   โ”œโ”€โ”€ ๐ŸŽฎ controllers/
โ”‚   โ”‚   โ”œโ”€โ”€ ๐Ÿ“Š models/
โ”‚   โ”‚   โ”œโ”€โ”€ ๐Ÿ›ฃ๏ธ routes/
โ”‚   โ”‚   โ”œโ”€โ”€ ๐Ÿ› ๏ธ utils/
โ”‚   โ”‚   โ””โ”€โ”€ ๐Ÿš€ server.js
โ”‚   โ”œโ”€โ”€ ๐Ÿ“Š models/
โ”‚   โ””โ”€โ”€ ๐Ÿ“ฆ package.json
โ””โ”€โ”€ ๐Ÿ“ README.md

๐Ÿš€ Getting Started

โš™๏ธ Prerequisites

  • ๐Ÿ’ป Node.js (v14 or higher)
  • ๐Ÿƒ MongoDB
  • ๐Ÿ”ฅ Firebase account
  • โ˜๏ธ Cloudinary account

๐ŸŽจ Frontend Setup

# Navigate to Frontend directory
cd Frontend

# Install dependencies
npm install

# Start development server
npm run dev

โš™๏ธ Backend Setup

# Navigate to Backend directory
cd Backend

# Install dependencies
npm install

# Start server
npm run dev

๐Ÿ”‘ Environment Variables

๐ŸŽจ Frontend (.env)
VITE_API_URL=http://localhost:3000
VITE_FIREBASE_CONFIG=your_firebase_config
โš™๏ธ Backend (.env)
PORT=3000
MONGODB_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret
CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name
CLOUDINARY_API_KEY=your_cloudinary_api_key
CLOUDINARY_API_SECRET=your_cloudinary_api_secret

๐Ÿ“ API Routes

Route Description
๐Ÿ” /api/auth Authentication endpoints
๐Ÿ“š /api/course Course management
๐Ÿ‘จโ€๐Ÿซ /api/instructor Instructor operations
๐Ÿ“ /api/assessment Assessment system
๐Ÿ“Š /api/dashboard Dashboard data
๐Ÿ“ˆ /api/progress Progress tracking
๐Ÿ† /api/achievements Achievement system
๐ŸŽฎ /api/gamification Gamification features
๐Ÿค– /api/recommendations AI recommendations
๐Ÿ—บ๏ธ /api/roadmap Custom learning roadmaps

๐Ÿค Contributing

  1. ๐Ÿด Fork the repository
  2. ๐ŸŒฟ Create your feature branch (git checkout -b feature/AmazingFeature)
  3. ๐Ÿ’พ Commit your changes (git commit -m 'Add some AmazingFeature')
  4. ๐Ÿ“ค Push to the branch (git push origin feature/AmazingFeature)
  5. ๐Ÿ”„ Open a Pull Request

๐Ÿ“„ License

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

๐Ÿ‘จโ€๐Ÿ’ป Authors

Yash Parmar

Nayan Pawar

Siddhi Gawade

Tanishq Kulkarni

๐Ÿ™ Acknowledgments

  • ๐ŸŒŸ All contributors who have helped shape this project
  • ๐Ÿ’ก Open source community for the amazing tools and libraries
  • ๐ŸŽจ Design inspiration and resources
  • ๐Ÿ“š Educational content providers

๐ŸŒŸ Star this repo if you find it helpful! ๐ŸŒŸ

About

EduAI is a modern, AI-powered learning platform that provides personalized education experiences through interactive courses, assessments, and gamification features. Our platform combines cutting-edge technology with proven educational methodologies to create an engaging and effective learning environment.

Topics

Resources

Stars

Watchers

Forks

Contributors