README.md

---
title: SmartTutor AI
emoji: 🧠
colorFrom: blue
colorTo: purple
sdk: gradio
sdk_version: "4.44.1"
python_version: "3.10"
app_file: app.py
pinned: false
---


# 🧠 SmartTutor AI

SmartTutor AI is an intelligent educational assistant built with **CrewAI** and **Gradio**. It helps users summarize documents, generate quizzes, and get detailed explanations for their mistakes.

## ✨ Features

- **Document Summarization**: Get concise summaries from PDF or Text files.
- **Quiz Generation**: Automatically create multiple-choice quizzes based on document content.
- **Intelligent Grading**: Submit quiz answers and get detailed explanations for errors.
- **Quick Actions**: One-click shortcuts for common tasks.
- **Persistent Storage**: Quizzes are saved locally to `quizzes_db.json`.

## 🛠️ Setup

### 1. Requirements
Ensure you have Python 3.9+ installed.

### 2. Installation
Install the dependencies:
```bash
pip install -r requirements.txt
```

### 3. Environment Variables
1. Create a `.env` file from the example:
   ```bash
   cp .env.example .env
   ```
2. Open `.env` and add your `OPENAI_API_KEY`.

## 🚀 Usage

Run the application:
```bash
python app.py
```
The interface will be available at `http://localhost:7860`.

## 📁 Project Structure

- `app.py`: Main application and UI.
- `quizzes_db.json`: Local storage for generated quizzes.
- `requirements.txt`: Python dependencies.
- `.env`: Secret configuration (not included in version control).