chih.yikuan commited on
Commit
6288c42
ยท
1 Parent(s): ee9c668

fix: recreate README.md with proper YAML frontmatter for HF Spaces

Browse files
Files changed (1) hide show
  1. chatkit/README.md +68 -0
chatkit/README.md ADDED
@@ -0,0 +1,68 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: ClassLens
3
+ emoji: ๐Ÿ“Š
4
+ colorFrom: green
5
+ colorTo: pink
6
+ sdk: docker
7
+ sdk_version: "latest"
8
+ app_port: 7860
9
+ pinned: false
10
+ license: mit
11
+ short_description: AI-powered exam analysis that transforms Google Form quiz responses into beautiful, actionable reports for teachers.
12
+ ---
13
+
14
+ # ๐Ÿ“Š ClassLens
15
+
16
+ **AI-powered exam analysis that transforms Google Form quiz responses into beautiful, actionable reports for teachers.**
17
+
18
+ ## โœจ Features
19
+
20
+ - ๐Ÿ”— **Google Forms Integration**: Paste your Google Form response sheet URL
21
+ - ๐Ÿ“ˆ **Automatic Grading**: Compare student answers to your answer key
22
+ - ๐Ÿ“Š **Visual Statistics**: Interactive charts showing score distribution and per-question accuracy
23
+ - ๐ŸŽฏ **Detailed Explanations**: Bilingual (English + ไธญๆ–‡) explanations for each question
24
+ - ๐Ÿ‘ฅ **Peer Learning Groups**: AI-suggested groupings for collaborative learning
25
+ - ๐Ÿ“ง **Email Reports**: Send beautiful HTML reports directly to your inbox
26
+ - ๐ŸŽจ **Beautiful Reports**: Dark theme with Chart.js visualizations
27
+
28
+ ## ๐Ÿš€ How to Use
29
+
30
+ 1. **Paste your Google Form URL** (the response spreadsheet, not the form itself)
31
+ 2. **Provide your email** (for receiving the report)
32
+ 3. **Optionally add answer key** if not embedded in the form
33
+ 4. **Click analyze** and watch the AI work!
34
+
35
+ ## ๐Ÿ” Privacy
36
+
37
+ - Student names are displayed in full in reports for internal teacher use
38
+ - No data is stored permanently
39
+ - OAuth tokens are encrypted
40
+
41
+ ## ๐Ÿ› ๏ธ Tech Stack
42
+
43
+ - **Frontend**: React + Vite + TailwindCSS
44
+ - **Backend**: FastAPI + OpenAI ChatKit
45
+ - **Charts**: Chart.js
46
+ - **AI**: GPT-4.1-mini
47
+
48
+ ## ๐Ÿ“ Example Report Sections
49
+
50
+ ### ๐Ÿ“ Q&A Analysis (้กŒ็›ฎ่ฉณ่งฃ)
51
+ - Reading passages with highlighted key terms
52
+ - Per-question explanations with concept tags
53
+ - Common mistakes and solving strategies
54
+
55
+ ### ๐Ÿ“Š Statistics (ๆˆ็ธพ็ตฑ่จˆ)
56
+ - Score distribution bar chart
57
+ - Question accuracy doughnut chart
58
+ - Individual student performance table
59
+
60
+ ### ๐Ÿ‘ฉโ€๐Ÿซ Teacher Insights (ๆ•™ๅธซๅปบ่ญฐ)
61
+ - Overall performance analysis
62
+ - Teaching recommendations
63
+ - AI prompt for next quiz generation
64
+ - Individual student support suggestions
65
+
66
+ ---
67
+
68
+ Built with โค๏ธ by [taboola-cz](https://huggingface.co/taboola-cz) for educators