# EduEase

EduEase is a personalized learning platform designed to enhance the educational experience by tailoring content, quizzes, and AI-powered assistance to individual learning styles. The platform provides features like adaptive quizzes, progress tracking, and AI-driven doubt resolution to help students achieve their learning goals effectively.

## Features

- **Personalized Learning**: Tailored lessons and quizzes based on user preferences and learning styles.
- **AI-Powered Assistance**: Get instant help with doubts through the Edu Bot.
- **Progress Tracking**: Monitor your learning journey with detailed analytics and insights.
- **Adaptive Quizzes**: Quizzes evolve with your progress and knowledge level.
- **Offline Support**: EduEase AI works offline for uninterrupted learning.
- **Customizable Profiles**: Set preferences like learning pace, style, and career goals.

## Tech Stack

### Frontend
- **React**: For building the user interface.
- **Vite**: For fast development and build processes.
- **Tailwind CSS**: For styling and responsive design.
- **Framer Motion**: For animations and transitions.
- **Recharts**: For data visualization and charts.

### Backend
- **Node.js**: For server-side logic.
- **Express.js**: For building RESTful APIs.
- **MongoDB**: For database management using Mongoose.

### Additional Tools
- **Axios**: For API requests.
- **Radix UI**: For accessible and customizable UI components.
- **Sonner**: For toast notifications.

## Installation

### Prerequisites
- Node.js (v16 or higher)
- MongoDB (running locally or on a cloud service)

### Steps
1. Clone the repository:
   ```bash
   git clone https://github.com/your-username/EduEase.git
   cd EduEase

2. Install dependencies for both client and server:

   cd client
   npm install
   cd ../server
   npm install

3. Set up environment variables:

   • Create a .env file in the server directory with the following:

     MONGO_URI=your_mongodb_connection_string
     PORT=5000
     

4. Start the development servers:

   • Backend:

     cd server
     npm start

   • Frontend:

     cd client
     npm run dev

5. Open the application in your browser at http://localhost:5173.

Project Structure

EduEase/
├── client/                # Frontend code
│   ├── src/
│   │   ├── components/    # Reusable UI components
│   │   ├── pages/         # Application pages
│   │   ├── assets/        # Static assets (images, icons, etc.)
│   │   ├── lib/           # Utility functions
│   │   ├── App.jsx        # Main React component
│   │   ├── main.jsx       # Entry point
│   │   └── index.css      # Global styles
│   └── vite.config.js     # Vite configuration
├── server/                # Backend code
│   ├── controller/        # API controllers
│   ├── models/            # Mongoose schemas
│   ├── routes/            # API routes
│   └── server.js          # Entry point
└── README.md              # Project documentation

API Endpoints

Profile

• POST /api/save-profile: Save user profile data.
• GET /api/get-profile/:id: Fetch user profile by ID.

Quiz

• POST /api/store-quiz-results: Save quiz results.
• GET /api/get-recent-activity: Fetch recent quiz activity.

Chat

• POST /api/chat/ask: Ask a question to the Edu Bot.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature-name

3. Commit your changes:

   git commit -m "Add feature-name"

4. Push to your branch:

   git push origin feature-name

5. Open a pull request.

License

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

Acknowledgments

• React Icons: For providing icons used across the platform.
• Radix UI: For accessible and customizable UI components.
• Recharts: For data visualization.
• Framer Motion: For smooth animations.

Contact

For any inquiries or feedback, please reach out to [your-email@example.com].