Kerikim commited on
Commit
bd134a6
Β·
1 Parent(s): e72771f

elkay:: readme

Browse files
Files changed (1) hide show
  1. README.md +31 -7
README.md CHANGED
@@ -4,6 +4,16 @@
4
  $mart Kids is an AI-powered web-based learning platform designed to teach financial literacy through lessons, quizzes, and interactive games.
5
  Built with Streamlit, FastAPI, LangGraph, TiDB Cloud, and Hugging Face models, it leverages multi-agent AI workflows and vector search to provide personalized tutoring experiences for students, while giving teachers tools to manage classes and track progress.
6
 
 
 
 
 
 
 
 
 
 
 
7
  ✨ Features
8
  Student Dashboard
9
  Explore lessons, attempt quizzes (currently preloaded due to OSS constraints), receive AI tutor feedback, and play engaging games like Budget Builder and Debt Dilemma.
@@ -53,6 +63,27 @@ short_description: This is the Backend for Project - $mart Kids – AI Financial
53
  Built with FastAPI + LangGraph
54
  Handles agent flows, embeddings, and TiDB Cloud integration
55
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
  πŸš€ Run Instructions
57
  Access Online
58
  1. Open FinFront on Hugging Face - https://finedproj-finfront.hf.space/
@@ -74,13 +105,6 @@ Teachers β†’ lesson management, quiz tools, dashboards.
74
  (Note: quizzes are currently preloaded due to limitations in open-source LLM quiz generation.)
75
 
76
 
77
- πŸ› οΈ Tech Stack
78
- Frontend: Streamlit (FinFront)
79
- Backend: FastAPI + LangGraph (FinBack)
80
- Database: TiDB Cloud (with Vector Search)
81
- Models: Hugging Face (TinyLlama, E5 embeddings)
82
- Deployment: Hugging Face Spaces
83
-
84
 
85
  πŸ“œ License
86
  MIT License
 
4
  $mart Kids is an AI-powered web-based learning platform designed to teach financial literacy through lessons, quizzes, and interactive games.
5
  Built with Streamlit, FastAPI, LangGraph, TiDB Cloud, and Hugging Face models, it leverages multi-agent AI workflows and vector search to provide personalized tutoring experiences for students, while giving teachers tools to manage classes and track progress.
6
 
7
+ ❓ Problem & Solution
8
+ In Jamaica and many developing countries, students often lack engaging, accessible tools for learning financial literacy and numeracy. Traditional classrooms don’t adapt well to different learning paces, teachers struggle to track student progress at scale, and parents lack visibility.
9
+
10
+ **$mart Kids solves these challenges by:**
11
+ - Gamifying financial learning through XP and leaderboards.
12
+ - Offering a personalized AI tutor that adapts to each student.
13
+ - Providing teachers with dashboards, lesson creation tools, and real-time progress tracking.
14
+ - Allowing parents to receive detailed reports on student progress.
15
+
16
+
17
  ✨ Features
18
  Student Dashboard
19
  Explore lessons, attempt quizzes (currently preloaded due to OSS constraints), receive AI tutor feedback, and play engaging games like Budget Builder and Debt Dilemma.
 
63
  Built with FastAPI + LangGraph
64
  Handles agent flows, embeddings, and TiDB Cloud integration
65
 
66
+ πŸ› οΈ Tech Stack
67
+ Frontend: Streamlit (FinFront)
68
+ Backend: FastAPI + LangGraph (FinBack)
69
+ Database: TiDB Cloud (with Vector Search)
70
+ Models: Hugging Face (TinyLlama, E5 embeddings)
71
+ Deployment: Hugging Face Spaces
72
+
73
+
74
+ πŸ”„ Data Flow & Integration
75
+ 1. Student/Teacher Action β†’ User interacts with FinFront (Streamlit).
76
+ 2. API Requests β†’ FinFront communicates with FinBack (FastAPI).
77
+ 3. Database Operations β†’ FinBack stores and retrieves lessons, quizzes, and user progress from TiDB Cloud.
78
+ 4. Vector Search β†’ Lesson embeddings are stored in TiDB Cloud for semantic search and personalization.
79
+ 5. AI Models β†’ Hugging Face models (TinyLlama for chat, E5 for embeddings) are used for tutoring, explanations, and adaptive learning.
80
+ 6. Feedback Loop β†’ Results (XP, scores, progress) are sent back to dashboards in FinFront.
81
+
82
+
83
+ πŸ“Ή Demo Video
84
+ πŸ‘‰ https://app.supademo.com/demo/cmflwngwdfpoh39ozaycikuib?utm_source=link
85
+
86
+
87
  πŸš€ Run Instructions
88
  Access Online
89
  1. Open FinFront on Hugging Face - https://finedproj-finfront.hf.space/
 
105
  (Note: quizzes are currently preloaded due to limitations in open-source LLM quiz generation.)
106
 
107
 
 
 
 
 
 
 
 
108
 
109
  πŸ“œ License
110
  MIT License