Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,14 +1,88 @@
|
|
| 1 |
---
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
|
|
|
| 6 |
sdk: streamlit
|
| 7 |
-
sdk_version: 1.44.1
|
| 8 |
app_file: app.py
|
| 9 |
-
pinned:
|
| 10 |
-
|
| 11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
---
|
| 13 |
|
| 14 |
-
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
---
|
| 3 |
+
title: CoreQuest - Master Physics and Math with AI
|
| 4 |
+
emoji: 🎯
|
| 5 |
+
colorFrom: indigo
|
| 6 |
+
colorTo: purple
|
| 7 |
sdk: streamlit
|
|
|
|
| 8 |
app_file: app.py
|
| 9 |
+
pinned: true
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
# 🎯 CoreQuest: Master Physics and Math!
|
| 13 |
+
|
| 14 |
+
CoreQuest is an open-source AI-powered learning platform designed for high school and college students to master physics and mathematics through engaging, gamified learning experiences.
|
| 15 |
+
|
| 16 |
+
---
|
| 17 |
+
|
| 18 |
+
## 🚀 Features
|
| 19 |
+
|
| 20 |
+
- 🤖 **AI-generated content**: Get instant explanations and practice questions from Hugging Face’s Mistral-7B model.
|
| 21 |
+
- 💬 **Smart chatbot**: Ask topic-specific questions and receive instant answers.
|
| 22 |
+
- 🏆 **XP Progress System**: Level up as you interact (like Duolingo).
|
| 23 |
+
- 🔭 **Interactive Simulations**: View physics simulations from PhET.
|
| 24 |
+
- 🎁 **Hint and Retry System**: Get hints and generate new practice sets to master topics.
|
| 25 |
+
|
| 26 |
+
---
|
| 27 |
+
|
| 28 |
+
## 📚 Topics Covered
|
| 29 |
+
|
| 30 |
+
### Physics:
|
| 31 |
+
- Classical Mechanics
|
| 32 |
+
- Thermodynamics
|
| 33 |
+
- Electricity & Magnetism
|
| 34 |
+
- Optics
|
| 35 |
+
- Special Relativity
|
| 36 |
+
|
| 37 |
+
### Mathematics:
|
| 38 |
+
- Algebra
|
| 39 |
+
- Geometry
|
| 40 |
+
- Trigonometry
|
| 41 |
+
- Calculus I
|
| 42 |
+
- Calculus II
|
| 43 |
+
- Multivariable Calculus
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
+
|
| 47 |
+
## 🧩 How It Works
|
| 48 |
+
|
| 49 |
+
1. Enter a topic (e.g., "Newton’s Laws", "Derivatives").
|
| 50 |
+
2. The AI generates:
|
| 51 |
+
- A simple, short explanation.
|
| 52 |
+
- Three relevant practice questions.
|
| 53 |
+
3. Use the app to:
|
| 54 |
+
- Ask follow-up questions through the chatbot.
|
| 55 |
+
- View simulations connected to your topic.
|
| 56 |
+
- Earn XP points for each interaction and level up!
|
| 57 |
+
|
| 58 |
+
---
|
| 59 |
+
|
| 60 |
+
## 🔐 Security Notice
|
| 61 |
+
|
| 62 |
+
This app uses a Hugging Face Inference API token stored securely as a **Repository Secret** (`HF_TOKEN`).
|
| 63 |
+
No sensitive information is exposed in the code.
|
| 64 |
+
|
| 65 |
+
---
|
| 66 |
+
|
| 67 |
+
## ✨ Built With
|
| 68 |
+
|
| 69 |
+
- [Streamlit](https://streamlit.io) – UI Framework
|
| 70 |
+
- [Hugging Face Transformers](https://huggingface.co) – AI backend
|
| 71 |
+
- [PhET Simulations](https://phet.colorado.edu) – Physics simulation demos
|
| 72 |
+
- [Python Requests](https://docs.python-requests.org) – API handling
|
| 73 |
+
|
| 74 |
+
---
|
| 75 |
+
|
| 76 |
+
## 💡 Vision
|
| 77 |
+
|
| 78 |
+
**CoreQuest** was created for the **Tech Titans Hackathon** to empower students through intelligent, interactive learning, making STEM education accessible and fun.
|
| 79 |
+
|
| 80 |
+
We believe in:
|
| 81 |
+
- Making physics and math exciting and not intimidating.
|
| 82 |
+
- Combining games, simulations, and AI to personalize learning.
|
| 83 |
+
- Supporting students globally in mastering fundamental scientific concepts.
|
| 84 |
+
|
| 85 |
---
|
| 86 |
|
| 87 |
+
Made with ❤️ by Benjamin Kaindu Mushinge
|
| 88 |
+
|