README.md

# Educational Tutor Bot


**AI-powered educational chatbot for tutoring, Q&A, and learning assistance**

---

## 📚 Project Information

**Author:** RSK World (https://rskworld.in)
**Founded by:** Molla Samser
**Designer & Tester:** Rima Khatun
**Contact:** info@rskworld.com | +91 93305 39277
**Year:** 2026

---

## 🎯 Features

- **Subject Tutoring**: Get help in Mathematics, Science, History, English, Computer Science, and more
- **Q&A Support**: Ask questions and get detailed, educational answers
- **Concept Explanations**: Understand complex topics with clear, step-by-step explanations
- **Learning Resources**: Receive curated learning materials and study suggestions
- **Progress Tracking**: Monitor your learning progress across different subjects
- **Difficulty Levels**: Choose between Beginner, Intermediate, and Advanced levels
- **Chat History**: Review your past conversations and learning sessions
- **Responsive Design**: Works seamlessly on desktop, tablet, and mobile devices

---

## 🛠️ Technologies Used

- **Backend**: Python 3.8+, Flask 2.3.3
- **AI/ML**: OpenAI API (GPT-3.5-turbo)
- **Database**: SQLite3
- **Frontend**: HTML5, CSS3, JavaScript, Bootstrap 5
- **NLP**: Natural Language Processing for educational content
- **Icons**: Font Awesome 6.0

---

## 📋 Prerequisites

- Python 3.8 or higher
- OpenAI API key
- Git (for cloning)

---

## 🚀 Installation & Setup

### 1. Clone the Repository

```bash
git clone https://github.com/rskworld/educational-tutor-bot.git
cd educational-tutor-bot
```

### 2. Create Virtual Environment

```bash
python -m venv venv

# Windows
venv\Scripts\activate

# macOS/Linux
source venv/bin/activate
```

### 3. Install Dependencies

```bash
pip install -r requirements.txt
```

### 4. Environment Configuration

```bash
# Copy the example environment file
cp .env.example .env

# Edit .env file and add your OpenAI API key
OPENAI_API_KEY=your_actual_openai_api_key_here
```

### 5. Create Data Directory

```bash
mkdir -p data logs
```

### 6. Run the Application

```bash
python app.py
```

The application will be available at `http://localhost:5000`

---

## 🎮 Usage

1. **Open your browser** and navigate to `http://localhost:5000`
2. **Select your subject** from the dropdown menu (optional)
3. **Choose difficulty level** - Beginner, Intermediate, or Advanced
4. **Start asking questions** in the chat interface
5. **View your progress** by clicking the "View Progress" button
6. **Check chat history** to review previous conversations

---

## 📁 Project Structure

```
educational-tutor-bot/
├── app.py # Main Flask application
├── config.py # Configuration settings
├── requirements.txt # Python dependencies
├── .env.example # Environment variables template
├── README.md # Project documentation
├── templates/
│ └── index.html # Main HTML template
├── static/
│ ├── css/
│ │ └── style.css # Custom styles
│ └── js/
│ └── script.js # JavaScript functionality
├── data/
│ └── tutor_bot.db # SQLite database (auto-created)
└── utils/
└── (helper functions)
```

---

## 🔧 Configuration

### Environment Variables

- `OPENAI_API_KEY`: Your OpenAI API key (required)
- `FLASK_ENV`: Environment (development/production)
- `SECRET_KEY`: Flask secret key
- `HOST`: Server host (default: 0.0.0.0)
- `PORT`: Server port (default: 5000)

### Supported Subjects

- Mathematics
- Science (Physics, Chemistry, Biology)
- History
- English
- Computer Science
- Geography
- Literature
- General Knowledge

---

## 📊 API Endpoints

- `GET /`: Main application page
- `POST /chat`: Send message and get AI response
- `GET /progress`: Get user learning progress
- `GET /history`: Get chat history

---

## 🗄️ Database Schema

The application uses SQLite with three main tables:

1. **users**: User session information
2. **learning_sessions**: Learning progress tracking
3. **chat_history**: Conversation history

---

## 🎨 Customization

### Adding New Subjects

1. Add subject to `SUPPORTED_SUBJECTS` in `config.py`
2. Add custom system prompt to `SYSTEM_PROMPTS` in `config.py`
3. Update the subject dropdown in `templates/index.html`

### Modifying AI Behavior

Edit the system prompts in `config.py` to customize the AI tutor's personality and teaching style.

---

## 🐛 Troubleshooting

### Common Issues

1. **OpenAI API Error**: Make sure your API key is valid and has sufficient credits
2. **Database Error**: Ensure the `data` directory exists and is writable
3. **Port Already in Use**: Change the PORT in `.env` file or stop conflicting services

### Getting Help

- Email: support@rskworld.com
- Phone: +91 93305 39277
- Website: https://rskworld.in

---

## 🤝 Contributing

We welcome contributions! Please follow these steps:

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](LICENSE) file for details.

---

## 🙏 Acknowledgments

- **OpenAI** for providing the GPT API
- **Flask** team for the excellent web framework
- **Bootstrap** for the responsive UI components
- **Font Awesome** for the beautiful icons

---

## 📞 Contact

**RSK World**
Nutanhat, Mongolkote
Purba Burdwan, West Bengal
India, 713147

📧 Email: info@rskworld.com
📞 Phone: +91 93305 39277
🌐 Website: https://rskworld.in

---

**© 2026 RSK World. All rights reserved.**
*Content used for educational purposes only.*

---

*"Empowering education through AI technology"* 🎓