elkay:: readme

README.md

@@ -1,5 +1,26 @@
+💡 Project: $mart Kids – AI Financial Literacy Platform
+
+🌍 Overview
+$mart Kids is an AI-powered web-based learning platform designed to teach financial literacy through lessons, quizzes, and interactive games.
+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.
+
+✨ Features
+Student Dashboard
+Explore lessons, attempt quizzes (currently preloaded due to OSS constraints), receive AI tutor feedback, and play engaging games like Budget Builder and Debt Dilemma.
+
+Teacher Dashboard
+Create and manage lessons, assign quizzes, and track student performance with intuitive dashboards.
+
+Gamified Learning
+Earn XP, compete on leaderboards, and reinforce knowledge through play.
+
+Powered by Modern Tech
+Built with Streamlit (frontend), FastAPI + LangGraph (backend), and TiDB Cloud (database + vector search).
+
+📦 Project Structure
+Frontend: FInFront
 ---
-title: FInFront
+title: FinFront
 emoji: 🚀
 colorFrom: red
 colorTo: red
@@ -9,11 +30,77 @@ tags:
   - streamlit
 pinned: false
 app_file: app.py
-short_description: This is the frontend for project
+short_description: This is the frontend for Project - $mart Kids – AI Financial Literacy Platform
 license: mit
 sdk_version: 1.49.1
 ---
+Runs on Streamlit
+Provides student and teacher dashboards
+Deployed on Hugging Face Spaces
+
+
+Backend: FinBack
+---
+title: FInBack
+emoji: 👀
+colorFrom: purple
+colorTo: blue
+sdk: docker
+pinned: false
+license: mit
+short_description: This is the Backend for Project - $mart Kids – AI Financial Literacy Platform
+---
+Built with FastAPI + LangGraph
+Handles agent flows, embeddings, and TiDB Cloud integration
+
+🚀 Run Instructions
+Access Online
+1. Open FinFront on Hugging Face - https://finedproj-finfront.hf.space/
+2. Click the Welcome dropdown in the sidebar.
+3. Choose Sign Up as a Student or Teacher and complete the form.
+    This will take you to the login page where you can use the credential that you just created or the pre-created ones below. 
+
+                Student
+                Username: tidbhack_student@email.com
+                Password: hacking2025
+
+                Teacher
+                Username: tidbhack_teacher@email.com
+                Password: hacking2025
+
+4. After signup:
+Students → lessons, quizzes, games, AI tutor.
+Teachers → lesson management, quiz tools, dashboards.
+(Note: quizzes are currently preloaded due to limitations in open-source LLM quiz generation.)
+
+
+🛠️ Tech Stack
+Frontend: Streamlit (FinFront)
+Backend: FastAPI + LangGraph (FinBack)
+Database: TiDB Cloud (with Vector Search)
+Models: Hugging Face (TinyLlama, E5 embeddings)
+Deployment: Hugging Face Spaces
+
+
+📜 License
+MIT License
+
+Copyright (c) 2025 lanna_lalala;-;
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-# FinFront
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-This was created to be a learning web platform for the Jamaican youth to understand financial literacy and numeracy.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.