Spaces:
Build error
Build error
| title: Curriculum Assistant | |
| emoji: 📚 | |
| colorFrom: blue | |
| colorTo: green | |
| sdk: streamlit | |
| sdk_version: 1.36.0 | |
| python_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. | |
| ## How to Use / استعمال کا طریقہ | |
| 1. **Upload PDF / پی ڈی ایف اپ لوڈ کریں**: Upload a Grade 1–12 curriculum PDF containing SLOs (e.g., “Grade 6 Science: Students will understand the basic cell structure”). | |
| 2. **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). | |
| 3. **Choose Output / آؤٹ پٹ منتخب کریں**: Pick Lesson Plan (BOPPPS or Backward Design), Flashcards, or Worksheet. | |
| 4. **Generate / بنائیں**: Click the “Generate” button to create your content. | |
| 5. **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 / ترتیب دینے کے ہدایات | |
| 1. **Create a Space / اسپیس بنائیں**: | |
| - Go to [Hugging Face Spaces](https://huggingface.co/spaces). | |
| - Click “Create new Space.” | |
| - Select **Streamlit** as the SDK, choose **Public** or **Private**, and pick **Free** CPU hardware. | |
| 2. **Upload Files / فائلیں اپ لوڈ کریں**: | |
| - Upload `app.py`, `requirements.txt`, `README.md`, and `sample_curriculum.txt` via the **Files** tab or Git. | |
| 3. **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). | |
| 4. **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 / مسائل کا حل | |
| - **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 | |