YazeedBinShihah commited on
Commit
1561a35
Β·
verified Β·
1 Parent(s): 1155df6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +57 -44
README.md CHANGED
@@ -1,44 +1,57 @@
1
- # 🧠 SmartTutor AI
2
-
3
- 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.
4
-
5
- ## ✨ Features
6
-
7
- - **Document Summarization**: Get concise summaries from PDF or Text files.
8
- - **Quiz Generation**: Automatically create multiple-choice quizzes based on document content.
9
- - **Intelligent Grading**: Submit quiz answers and get detailed explanations for errors.
10
- - **Quick Actions**: One-click shortcuts for common tasks.
11
- - **Persistent Storage**: Quizzes are saved locally to `quizzes_db.json`.
12
-
13
- ## πŸ› οΈ Setup
14
-
15
- ### 1. Requirements
16
- Ensure you have Python 3.9+ installed.
17
-
18
- ### 2. Installation
19
- Install the dependencies:
20
- ```bash
21
- pip install -r requirements.txt
22
- ```
23
-
24
- ### 3. Environment Variables
25
- 1. Create a `.env` file from the example:
26
- ```bash
27
- cp .env.example .env
28
- ```
29
- 2. Open `.env` and add your `OPENAI_API_KEY`.
30
-
31
- ## πŸš€ Usage
32
-
33
- Run the application:
34
- ```bash
35
- python app.py
36
- ```
37
- The interface will be available at `http://localhost:7860`.
38
-
39
- ## πŸ“ Project Structure
40
-
41
- - `app.py`: Main application and UI.
42
- - `quizzes_db.json`: Local storage for generated quizzes.
43
- - `requirements.txt`: Python dependencies.
44
- - `.env`: Secret configuration (not included in version control).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: SmartTutor AI
3
+ emoji: 🧠
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: gradio
7
+ sdk_version: "4.44.1"
8
+ python_version: "3.10"
9
+ app_file: app.py
10
+ pinned: false
11
+ ---
12
+
13
+
14
+ # 🧠 SmartTutor AI
15
+
16
+ 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.
17
+
18
+ ## ✨ Features
19
+
20
+ - **Document Summarization**: Get concise summaries from PDF or Text files.
21
+ - **Quiz Generation**: Automatically create multiple-choice quizzes based on document content.
22
+ - **Intelligent Grading**: Submit quiz answers and get detailed explanations for errors.
23
+ - **Quick Actions**: One-click shortcuts for common tasks.
24
+ - **Persistent Storage**: Quizzes are saved locally to `quizzes_db.json`.
25
+
26
+ ## πŸ› οΈ Setup
27
+
28
+ ### 1. Requirements
29
+ Ensure you have Python 3.9+ installed.
30
+
31
+ ### 2. Installation
32
+ Install the dependencies:
33
+ ```bash
34
+ pip install -r requirements.txt
35
+ ```
36
+
37
+ ### 3. Environment Variables
38
+ 1. Create a `.env` file from the example:
39
+ ```bash
40
+ cp .env.example .env
41
+ ```
42
+ 2. Open `.env` and add your `OPENAI_API_KEY`.
43
+
44
+ ## πŸš€ Usage
45
+
46
+ Run the application:
47
+ ```bash
48
+ python app.py
49
+ ```
50
+ The interface will be available at `http://localhost:7860`.
51
+
52
+ ## πŸ“ Project Structure
53
+
54
+ - `app.py`: Main application and UI.
55
+ - `quizzes_db.json`: Local storage for generated quizzes.
56
+ - `requirements.txt`: Python dependencies.
57
+ - `.env`: Secret configuration (not included in version control).