ngwakomadikwe commited on
Commit
6f42384
Β·
verified Β·
1 Parent(s): ed2729e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +11 -38
README.md CHANGED
@@ -1,44 +1,17 @@
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:
 
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).