# ๐Ÿ“– User Guide โ€” HMG ACADEMY CLASS DECK v9 End-user walkthrough for teachers, students, and parents. --- ## ๐Ÿ‘ฉโ€๐Ÿซ For Teachers ### 1. Sign up 1. Open `teach.html` on your tablet, laptop, or phone. 2. Click **Create account** tab. 3. Fill in: - Your full name - Email - Phone (WhatsApp number โ€” this is where your access key will be sent) - School (optional) - Password (โ‰ฅ 8 characters) 4. Click **Start my 3-day free trial โžœ**. You are now in the **Teacher Studio**. No payment needed for the next 3 days. ### 2. The Studio The Studio has two side-by-side panes, each of which can show one of: - โœ **Whiteboard** โ€” draw, type, erase, add shapes - ๐Ÿ“„ **PDF** โ€” open a PDF file - ๐ŸŒ **Browser** โ€” open any URL (with the education library shortcut) - ๐Ÿ—’ **Notes** โ€” a plain-text notepad - ๐Ÿ–ผ **Image** โ€” show a picture - ๐Ÿ“ˆ **Graph** โ€” plot a function - ๐ŸŽฌ **Video** โ€” play a local video - ๐Ÿงฐ **Toolkit** โ€” geometry tools (compass, ruler, etc.) - ๐Ÿƒ **Cards** โ€” flashcards - โฑ **Timer** โ€” stopwatch or countdown Click a tab to switch. Drag the centre divider to resize. ### 3. Start a live class 1. Click **โ–ถ Go Live** (top right). 2. A 6-character **room code** appears. Tell your students to open `join.html` and enter the code. 3. The Roster panel (๐Ÿ‘ฅ) shows every student as they join. 4. To broadcast what you do, students see your composite stream automatically (whiteboard + PDF together). ### 4. Use the activities Click the **Roster** drawer โ†’ **Tools** tab โ†’ choose: - **๐Ÿ’ฌ Open question** โ€” type a prompt, students answer - **โ˜ Word cloud** โ€” students submit one word, real-time cloud - **๐ŸŽŸ Exit ticket** โ€” end-of-lesson check - **๐Ÿ‘ฅ Random groups** โ€” pick number of groups, students are shuffled - **๐Ÿ”Š Noise meter** โ€” class volume gauge on student screens - **๐Ÿ˜Š Mood poll** โ€” yes/no "how do you feel" - **๐Ÿ† Quick quiz** โ€” type `Question | Option1 | Correct! | Option3` ### 5. Assign homework 1. Click **๐Ÿ“Š Dashboard** in top right โ†’ **Assignments** tab. 2. Fill in: title, category, weight, due date. 3. Click **Create**. 4. Students see the assignment on their screen (if they're in your class). 5. After the due date, click the assignment โ†’ grade each submission. ### 6. View analytics Dashboard โ†’ **Analytics** tab โ†’ see engagement, grade distribution, badge leaders. ### 7. End class Click **โน Stop Live** (top right). ### 8. After 3 days When your trial expires, the Studio locks. Two options: - **Buy an HMG ACCESS KEY** from โ€” pay the small licence fee, receive a key on WhatsApp within minutes. - Paste the key in the **Activate key** tab โ†’ **Activate**. --- ## ๐ŸŽ“ For Students ### Join a class 1. Open `join.html` (your teacher will give you the URL). 2. Enter the **room code** (6 characters, uppercase). 3. Enter your **name**. 4. (Optional) Enter the **class PIN** if your teacher set one. 5. Click **Join class โžœ**. You will see the teacher's screen (whiteboard + PDF together) and you can chat. ### React The bottom row of buttons lets you: - โœ‹ Raise your hand - ๐Ÿ‘ / โค๏ธ / ๐Ÿ˜‚ / ๐ŸŽ‰ / ๐Ÿ˜ฎ / ๐Ÿ‘ Send a reaction ### Your personal whiteboard If the teacher presses **๐ŸŽจ Start boards**, you'll see a personal whiteboard. Only the teacher sees it. Tap to draw. **๐Ÿ“บ Lesson** swaps back to the teacher's view. ### Submit homework When the teacher creates an assignment, you'll see a submit button on your screen. Tap it, type your answer, submit. ### Camera / microphone The teacher can ask you to share your camera/mic. You'll get a pop-up โ€” accept or decline. ### Leave class Click **๐Ÿšช Leave** in the top right. --- ## ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘ง For Parents ### View your child's report 1. Ask the teacher for a **parent code** (6 characters). 2. Open `parent.html` (or the URL the teacher gave you). 3. Enter the code โ†’ **View report โžœ**. You see: - Overall % - Recent grades - Badges earned - Portfolio highlights ### Print / save as PDF Click **๐Ÿ–จ Print / Save as PDF** at the top of the report. --- ## โŒจ Keyboard shortcuts | Shortcut | Action | |---|---| | `Alt+C` | Toggle high-contrast | | `Alt+D` | Toggle dyslexia-friendly font | | `Alt+S` | Cycle text size (S โ†’ L โ†’ XL) | | `Shift+?` or `F1` | Show shortcut overlay | | `Esc` | Close any modal | --- ## ๐ŸŒ Languages Click the ๐ŸŒ button in the top right to switch between: - ๐Ÿ‡ฌ๐Ÿ‡ง English - ๐Ÿ‡ซ๐Ÿ‡ท Franรงais - ๐Ÿ‡ช๐Ÿ‡ธ Espaรฑol - ๐Ÿ‡ง๐Ÿ‡ท Portuguรชs - ๐Ÿ‡ธ๐Ÿ‡ฆ ุงู„ุนุฑุจูŠุฉ (RTL) - ๐Ÿ‡ฎ๐Ÿ‡ณ เคนเคฟเคจเฅเคฆเฅ€ - ๐Ÿ‡ฐ๐Ÿ‡ช Kiswahili - ๐Ÿ‡ณ๐Ÿ‡ฌ Hausa - ๐Ÿ‡ณ๐Ÿ‡ฌ Yorรนbรก - ๐Ÿ‡ณ๐Ÿ‡ฌ Igbo To add a new language: copy `locales/en.json` โ†’ translate โ†’ save as `locales/.json` โ†’ reload. --- ## ๐Ÿ“ฒ Install as an app ### On Android 1. Open the site in Chrome. 2. Tap the menu (โ‹ฎ) โ†’ **Add to Home screen**. 3. The app installs to your home screen and works offline. ### On iPhone 1. Open the site in Safari. 2. Tap the Share button โ†’ **Add to Home Screen**. ### On laptop (Chrome / Edge) 1. Open the site. 2. Click the install icon in the URL bar. Once installed, the app works **fully offline** โ€” whiteboard, PDF, notes, toolkit, flashcards, timer. The live class still needs internet. --- ## ๐Ÿ’ก Tips & tricks - **Use Companion mode for Google Meet**: open `teach.html?meet=1`. The live-class panel is hidden so you can share your screen on Meet without distractions. - **Drag the centre divider** in the Studio to give the whiteboard more room. - **Press F1** for keyboard shortcuts any time. - **Export everything** from the Dashboard's **๐Ÿ“ฅ Export all** button โ€” saves a single CSV with students, assignments, grades, poll responses. --- ## โ“ FAQ See `docs/FAQ.md` for 30+ common questions. --- ## ๐Ÿ†˜ Support - File an issue: - Email: **[email protected]** - WhatsApp: