shiny-build
Quintin Jeremy Mellembuild me a website
Comments (0)
Sign in to leave a comment
System Requirements
System Requirements Document
Project Name: Thinkr - CAPS Teacher Materials Platform
Introduction
Thinkr is a web-based educational platform designed to provide South African educators and students with access to CAPS-aligned teaching resources. The platform supports interactive teaching sequences, student-driven learning, and offline functionality. It is compliant with POPIA (Protection of Personal Information Act) and tailored for educational use in South Africa.
System Overview
Thinkr aims to bridge the gap between educators and students by offering a comprehensive suite of tools for teaching and learning. The platform includes features for teachers to manage lessons, create offline bundles, and track progress, while students can access lessons on demand, interact with teaching sequences, and practice their understanding through quizzes. The system ensures privacy compliance and local data storage, making it suitable for South African classrooms.
Functional Requirements
Teacher Features
- As a Teacher, I should be able to log in securely using a demo token.
- As a Teacher, I should be able to filter teaching materials by grade, subject, term, and phase.
- As a Teacher, I should be able to view detailed information about teaching nodes, including learning outcomes, strategies, misconceptions, assessments, and answer keys.
- As a Teacher, I should be able to export node content as Markdown for offline use.
- As a Teacher, I should be able to create offline bundles by selecting grades and subjects.
- As a Teacher, I should be able to add teaching nodes to offline bundles.
Student Features
- As a Student, I should be able to browse available lessons by grade, subject, and topic.
- As a Student, I should be able to access interactive lessons with voice-driven teaching sequences and visual aids.
- As a Student, I should be able to practice my understanding through quizzes with instant feedback.
- As a Student, I should be able to track my progress locally without sharing personal data.
- As a Student, I should be able to consent to local data storage for progress tracking.
User Personas
Teacher
- Role: Educator
- Goals: Access CAPS-aligned teaching materials, create offline bundles, and manage classroom lessons.
- Needs: Secure login, detailed teaching resources, and offline functionality.
Student
- Role: Learner
- Goals: Access lessons on demand, interact with teaching sequences, and practice understanding.
- Needs: Easy navigation, interactive lessons, and progress tracking.
Visuals Colors and Theme
Color Palette
- primary: #1e40af (Deep Indigo)
- primary_light: #3b82f6 (Bright Blue)
- secondary: #64748b (Slate Gray)
- accent: #f43f5e (Vivid Coral)
- highlight: #f59e0b (Amber Gold)
- bg: #f8fafc (Soft White)
- surface: rgba(255, 255, 255, 0.8) (Translucent White)
- text: #1e293b (Charcoal)
- text_muted: #94a3b8 (Muted Gray)
- border: rgba(100, 116, 139, 0.2) (Subtle Gray)
Signature Design Concept
Interactive Classroom Dashboard
The homepage will feature an Interactive Classroom Dashboard designed to captivate both teachers and students. The dashboard will include:
- Dynamic Navigation: Sidebar navigation for Grades, Subjects, and Topics that activates based on user selection.
- Interactive Lesson Cards: Each lesson card will "flip" when hovered, revealing metadata like grade, term, and subject.
- Visual Sync Zone: A central teaching area with SVG animations that dynamically illustrate concepts (e.g., fractions dividing into equal parts).
- Progress Tracker: A circular progress bar that fills as students complete lessons and quizzes.
- Micro-Interactions: Buttons and cards will have spring physics animations using
framer-motionfor a playful yet professional feel.
Libraries:
@react-three/fiber+@react-three/dreifor 3D elements in the Visual Sync Zone.framer-motionfor spring physics and hover animations.gsapfor scroll-triggered transitions.
Interaction Model & Motion Direction
Landing Page Interaction Model: Parallax
The landing page will use a parallax interaction model:
- Layers of educational icons (books, pencils, chalkboards) will move at different speeds as users scroll.
- Real content like lesson cards and filters will scroll naturally.
- Hover effects will highlight interactive elements, such as lesson cards and buttons.
Internal Pages Interaction Model: Animated
Internal pages (e.g., dashboard, lesson detail, practice) will feature:
- Scroll-triggered reveals for sections.
- Hover transitions for buttons and cards.
- Spring physics for interactive elements.
Non-Functional Requirements
- Performance: The platform must load within 3 seconds on standard broadband connections.
- Scalability: Support up to 10,000 concurrent users.
- Accessibility: Ensure WCAG 2.1 compliance for visually impaired users.
- Security: Token-based authentication and HTTPS for secure communication.
- Privacy: Comply with POPIA regulations for local data storage.
Tech Stack
Frontend
- React for Web
- HTML/CSS for responsive design
framer-motionfor animations@react-three/fiber+@react-three/dreifor 3D elements
Backend
- FastAPI for API endpoints
- Python for backend logic
Database
- MongoDB for storing teaching nodes and metadata
- LocalStorage for offline progress tracking
AI Tools
- GPT 5.4 for generating interactive teaching content
- Litellm for LLM routing
Orchestration
- Docker for local development
- Kubernetes for deployment
Assumptions and Constraints
- The platform will only support English content initially.
- Offline bundles will be stored locally and require manual download.
- Access to the platform is restricted to users with a valid demo token.
Glossary
- CAPS: Curriculum and Assessment Policy Statement, the South African educational framework.
- POPIA: Protection of Personal Information Act, ensuring privacy compliance.
- Teaching Node: A unit of teaching material, including strategies, outcomes, and assessments.
- Offline Bundle: A downloadable package of teaching nodes for offline use.
Voice-Driven Learning, Locally Private
shiny-build delivers CAPS-aligned, voice-driven teaching and interactive practice sessions — all while keeping your data stored locally on your device. Learn at your pace, online or offline.
Built for Learning, Designed for Privacy
Three pillars that make shiny-build a trusted companion for students, parents, and educators across South Africa.
Interactive Teaching
Voice-driven lessons aligned with the CAPS curriculum guide students through each concept step by step, with synchronized visual cues that reinforce understanding.
Local Storage
All learning progress stays on the student's own device. No personal data is collected or synced to the cloud without explicit consent — full POPIA compliance built in.
Offline-Ready
English text-to-speech works without an internet connection, so students can continue learning anywhere — in the classroom, at home, or on the go.
Everything you need to learn smarter
shiny-build combines voice-driven teaching, CAPS-aligned content, and privacy-first design to create a seamless learning experience.
Voice-Driven Sequences
Learn through natural voice-guided teaching sequences aligned with CAPS curriculum standards. Pause, skip, or replay at your own pace.
Explore teaching→CAPS Alignment
Every lesson maps directly to the Curriculum and Assessment Policy Statement, ensuring grade-appropriate content for Grades 5 and 7.
View curriculum→Interactive Practice
Engage with dynamic practice sessions that adapt to your understanding. Answer questions and track mastery in real time.
Start practicing→Privacy by Default
No voice recordings, no location data, no personal identifiers collected. Your learning stays on your device unless you opt in.
Read our policy→Data Export
One-tap export of your learning progress. Full control over your data with easy deletion options for complete peace of mind.
Manage your data→Instant Feedback
Get immediate, meaningful feedback on every answer. Understand where you went wrong and how to improve before moving on.
See how it works→Your Data, Your Control.
shiny-build is built on a privacy-first foundation. Your learning data never leaves your device unless you say so — fully POPIA compliant.
Your learning data stays on your device. Cloud synchronisation only activates when you explicitly opt in — never by default.
Download all your progress, session logs, and mastery data instantly with a single tap. Your data, portable and accessible.
Erase every trace of your stored data in one action. No hidden caches, no lingering records, no questions asked.
Full compliance with the Protection of Personal Information Act. No voice recordings, location data, or personal identifiers collected.
A Journey for Every Learner
Whether you teach, parent, or learn — shiny-build adapts to your role with a personalised pathway through voice-driven, CAPS-aligned education.
Educator
Empower your classroom with CAPS-aligned voice-driven lessons and real-time student insights.
- 1Browse CAPS-aligned teaching modules by grade and subject
- 2Assign voice-driven lesson sequences to your class
- 3Monitor individual student mastery progress locally
- 4Review practice session results and identify gaps
- 5Customise teaching pace with pause, skip, and repeat controls
- 6Export anonymised class reports for parent meetings
Parent
Stay informed on your child's learning journey with full privacy control and transparent progress.
- 1Review your child's POPIA-compliant privacy consent
- 2View learning progress stored safely on the device
- 3Track mastery milestones across subjects and topics
- 4Enable or disable optional cloud sync with one tap
- 5Export or delete all stored data at any time
- 6Connect with educators through secure channels
- 7Access offline learning for uninterrupted study
Student
Learn at your own pace with interactive voice lessons and instant feedback on every answer.
- 1Choose your grade and select a subject to explore
- 2Listen to voice-driven teaching aligned to your curriculum
- 3Pause, skip, or replay any teaching step
- 4Transition to interactive practice when you're ready
- 5Receive instant feedback on every answer
- 6Track your mastery progress across topics
Dive Deeper Into shiny-build
Discover what powers our platform, explore the tools we offer, and see how we protect your data at every step.
About the Platform
Learn how shiny-build delivers CAPS-aligned, voice-driven tutoring that adapts to every learner — from Grade 5 through Grade 7 and beyond.
Meet the mission→View Our Services
Explore interactive practice sessions, instant feedback, offline TTS support, and tools built for educators, parents, and students alike.
Explore services→Privacy & Compliance
Your data stays yours. Fully POPIA-compliant with local-only storage, one-tap data export, and zero collection of personal identifiers.
Read our policy→Ready to Transform Learning?
Join thousands of South African students already learning with voice-driven, CAPS-aligned AI tutoring. Private, offline-capable, and built for every learner.
No comments yet. Be the first!