Spaces:
Runtime error
Runtime error
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,44 +1,17 @@
|
|
| 1 |
-
# π ThutoAI
|
| 2 |
|
| 3 |
-
|
| 4 |
|
| 5 |
-
##
|
| 6 |
|
| 7 |
-
|
| 8 |
-
-
|
| 9 |
-
-
|
| 10 |
-
-
|
| 11 |
-
-
|
| 12 |
-
- **π Grades**: Academic performance tracking
|
| 13 |
-
- **π Syllabus**: Course content and learning objectives
|
| 14 |
-
- **π
Timetable**: Class schedules and teacher information
|
| 15 |
|
| 16 |
-
|
| 17 |
-
- **π Secure Admin Panel**: Complete school content management
|
| 18 |
-
- **π’ Announcement Management**: Create and manage school announcements
|
| 19 |
-
- **π Syllabus Management**: Add course content, topics, and resources
|
| 20 |
-
- **π
Timetable Management**: Create class schedules with teacher assignments
|
| 21 |
-
- **π Dashboard**: School statistics and overview
|
| 22 |
|
| 23 |
-
|
| 24 |
|
| 25 |
-
|
| 26 |
-
- **URL**: `/admin/login`
|
| 27 |
-
- **Username**: `admin`
|
| 28 |
-
- **Password**: `admin123`
|
| 29 |
-
|
| 30 |
-
### Student Access:
|
| 31 |
-
- **URL**: `/` (main page)
|
| 32 |
-
- No login required - direct access to all student features
|
| 33 |
-
|
| 34 |
-
## π Technical Stack
|
| 35 |
-
|
| 36 |
-
- **Backend**: Python Flask
|
| 37 |
-
- **AI**: OpenAI GPT-3.5-turbo
|
| 38 |
-
- **Database**: SQLite
|
| 39 |
-
- **Frontend**: HTML, CSS, JavaScript
|
| 40 |
-
- **Deployment**: Hugging Face Spaces
|
| 41 |
-
|
| 42 |
-
## π Environment Variables
|
| 43 |
-
|
| 44 |
-
Set the following environment variable in your Hugging Face Space:
|
|
|
|
| 1 |
+
# π ThutoAI β Student Assistant
|
| 2 |
|
| 3 |
+
An AI-powered web app for schools/universities built with Gradio & OpenAI.
|
| 4 |
|
| 5 |
+
## β
Features
|
| 6 |
|
| 7 |
+
- π’ Filter announcements by course
|
| 8 |
+
- π¬ Smart AI chatbot with school context
|
| 9 |
+
- π Upload study files (PDFs, notes)
|
| 10 |
+
- π Admin panel for teachers to post announcements
|
| 11 |
+
- π± Mobile-friendly, clean UI
|
|
|
|
|
|
|
|
|
|
| 12 |
|
| 13 |
+
## π Setup
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 14 |
|
| 15 |
+
Set `OPENAI_API_KEY` in HF Spaces Secrets for AI functionality.
|
| 16 |
|
| 17 |
+
Built for [Hugging Face Spaces](https://huggingface.co/spaces).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|