StudyAI 📚

An intelligent study assistant application powered by AI, designed to help students master their studies efficiently. StudyAI leverages advanced AI capabilities to generate summaries, create quizzes, build study notes, and provide interactive learning through an AI mentor chat.

✨ Features

• Smart Summarization: Automatically generate concise summaries from text, documents, and images
• Interactive Quizzes: AI-powered quiz generation with instant feedback and scoring
• Intelligent Study Notes: Extract key points, vocabulary, and personalized study schedules
• AI Mentor Chat: Real-time conversation with an AI mentor for study support and clarification
• Multi-Format Support: Process text, PDFs, Word documents, and images
• Text-to-Speech: Audio narration for accessibility and better retention
• Voice Input: Speech-to-text functionality for hands-free interaction
• Local Storage: Save your API key and learning history locally
• Responsive Design: Fully optimized for desktop and tablet devices

🛠️ Tech Stack

• Frontend Framework: React 19
• Build Tool: Vite with Rolldown
• Styling: Tailwind CSS 4
• Icons: Lucide React
• Document Processing:
  • Tesseract.js - OCR for images
  • PDF.js - PDF parsing
  • Mammoth.js - Word document support
• Code Quality: ESLint, Prettier
• Deployment: GitHub Pages

� Live Demo

👉 Visit StudyAI - Click to start using StudyAI now!

The application is already deployed and ready to use. Simply visit the link above to get started.

🛠️ Local Development (Optional)

If you want to contribute or run the project locally:

Prerequisites

• Node.js (v16 or higher)
• npm or yarn package manager

Installation

1. Clone the repository

   git clone https://github.com/mahmudul626/StudyAI.git
   cd StudyAI

2. Install dependencies

   npm install

3. Start the development server

   npm run dev

   The application will be available at http://localhost:5173

Build for Production

npm run build

This creates an optimized production build in the dist folder.

📖 Usage

1. Get Your API Key:

   • Visit Google AI Studio
   • Create a new API key for free
   • Copy the API key

2. Add API Key to StudyAI:

   • Open StudyAI application
   • Go to Settings
   • Paste your API key (it will be securely stored locally)

3. Input Content:

   • Paste text directly
   • Upload PDF, Word documents, or images

4. Choose Action:

   • Generate summary
   • Create quiz
   • Build study notes
   • Chat with AI mentor

5. Interact: Review results, ask follow-up questions, or download study materials

🧪 Code Quality

Linting

npm run lint

Runs ESLint to check code quality and adherence to best practices.

Environment Variables

Create a .env file in the root directory (optional for local development):

VITE_API_ENDPOINT=your_api_endpoint

📁 Project Structure

studyai/
├── src/
│   ├── App.jsx           # Main application component
│   ├── App.css           # Application styles
│   ├── main.jsx          # Entry point
│   ├── index.css         # Global styles
│   └── assets/           # Static assets
├── public/               # Public static files
├── index.html            # HTML template
├── vite.config.js        # Vite configuration
├── tailwind.config.js    # Tailwind CSS configuration
├── postcss.config.js     # PostCSS configuration
├── eslint.config.js      # ESLint configuration
└── package.json          # Project dependencies

🌐 Deployment

This project is deployed on GitHub Pages. Visit the live demo link at the top to access it.

To deploy your own fork:

npm run predeploy
npm run deploy

🤝 Contributing

Contributions are welcome! Please follow these guidelines:

1. Fork the repository
2. Create a 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 MIT License - see the LICENSE file for details.

🆘 Support

For issues, bugs, or feature requests, please:

• Email: mdmahmudulhasan1511@gmail.com
• Open an Issue on GitHub

🙏 Acknowledgments

• Thanks to all open-source libraries and communities that made this project possible
• Special thanks to the contributors and users of StudyAI

---

Happy Learning! 🎓