README.md

title: Curriculum Assistantemoji: 📚colorFrom: bluecolorTo: greensdk: gradiosdk_version: 4.31.0python_version: 3.10
Curriculum Assistant / نصابی اسسٹنٹ
A web app for K-12 teachers to create lesson plans, flashcards, and worksheets based on curriculum PDFs with Student Learning Outcomes (SLOs). It supports the BOPPPS and Backward Design models, offers multilingual (English/Urdu) support, and generates downloadable Microsoft Word (.docx) files. Built using Python, Gradio, and Hugging Face models.
How to Use / استعمال کا طریقہ

Upload PDF / پی ڈی ایف اپ لوڈ کریں: Upload a Grade 1–12 curriculum PDF containing SLOs (e.g., “Grade 6 Science: Students will understand the basic cell structure”).
Fill Form / فارم پُر کریں: Select grade (1–12), subject (Math, Science, etc.), topic (e.g., Photosynthesis), specific SLO (optional), and lesson duration (30, 45, or 60 minutes).
Choose Output / آؤٹ پٹ منتخب کریں: Pick Lesson Plan (BOPPPS or Backward Design), Flashcards, or Worksheet.
Generate / بنائیں: Click the “Generate” button to create your content.
Download / ڈاؤن لوڈ کریں: Download the output as a Microsoft Word (.docx) file.

Sample Query / نمونہ سوال

“Generate a Grade 6 Math worksheet on fractions / گریڈ 6 ریاضی کی ورک شیٹ بنائیں جو کسر پر ہو۔”
“Create a Grade 4 English BOPPPS lesson plan on nouns / گریڈ 4 انگریزی کا BOPPPS سبق پلان بنائیں جو اسم پر ہو۔”

Setup Instructions / ترتیب دینے کے ہدایات

Create a Space / اسپیس بنائیں:
Go to Hugging Face Spaces.
Click “Create new Space.”
Select Gradio as the SDK, choose Public or Private, and pick Free CPU hardware.


Upload Files / فائلیں اپ لوڈ کریں:
Upload app.py, requirements.txt, README.md, and sample_curriculum.txt via the Files tab.


Set Secrets / راز ترتیب دیں:
In Space Settings, add HF_TOKEN (your Hugging Face access token) under Repository Secrets.
Optionally, add GROK_API_KEY if using the Grok API (not required for this app).


Build and Test / بنائیں اور ٹیسٹ کریں:
Hugging Face will build the app automatically after uploading files.
Check Logs for errors (e.g., missing dependencies).
Access the app at https://<your-username>-<space-name>.hf.space.



Troubleshooting / مسائل کا حل

Configuration Error / ترتیب کی خرابی: Ensure the YAML in README.md includes sdk: gradio, sdk_version: 4.31.0, and python_version: 3.10.
No Text in PDF / پی ڈی ایف میں متن نہیں: Ensure the PDF has text or is not corrupted. For scanned PDFs, the app uses OCR (requires Tesseract).
Library Errors / لائبریری کی خرابیاں: Verify all dependencies are listed in requirements.txt.
Token Issues / ٹوکن کے مسائل: Ensure HF_TOKEN is valid and set in Secrets.
Build Fails / بنانے میں ناکامی: Check Logs for details and ensure app.py and requirements.txt are correct.

Feedback / رائے
Use the feedback box in the app to report issues or suggest improvements / ایپ میں فیڈبیک باکس استعمال کریں تاکہ مسائل کی اطلاع دیں یا بہتری کے لیے تجاویز دیں۔
Built with ❤️ by xAI