ngwakomadikwe commited on
Commit
97527b3
Β·
verified Β·
1 Parent(s): 49888b0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +44 -14
README.md CHANGED
@@ -1,14 +1,44 @@
1
- ---
2
- title: SmartMate
3
- emoji: πŸŒ–
4
- colorFrom: indigo
5
- colorTo: pink
6
- sdk: gradio
7
- sdk_version: 5.46.1
8
- app_file: app.py
9
- pinned: false
10
- license: apache-2.0
11
- short_description: A smart conversational AI student tutor
12
- ---
13
-
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # πŸŽ“ ThutoAI - Complete Student Assistant
2
+
3
+ ThutoAI is a comprehensive AI-powered student assistant that combines intelligent chat capabilities with complete school management features.
4
+
5
+ ## 🌟 Features
6
+
7
+ ### For Students:
8
+ - **πŸ€– AI Chat Assistant**: Context-aware conversations with school data integration
9
+ - **πŸ“Š Student Dashboard**: Overview of academic information
10
+ - **πŸ“’ Announcements**: Latest school news and updates
11
+ - **πŸ“ Exams & Tests**: Upcoming assessments and deadlines
12
+ - **πŸ“Š Grades**: Academic performance tracking
13
+ - **πŸ“š Syllabus**: Course content and learning objectives
14
+ - **πŸ“… Timetable**: Class schedules and teacher information
15
+
16
+ ### For Administrators:
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
+ ## πŸš€ Quick Start
24
+
25
+ ### Admin Access:
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: