chih.yikuan commited on
Commit
d439ceb
ยท
1 Parent(s): 2a21b93

docs: update README.md with ClassLens content instead of ChatKit templates

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