EduGameHub - Rural Learning Platform

A gamified digital learning platform for rural school students (grades 6–12) focusing on STEM subjects. Built with React, TypeScript, and Tailwind CSS, designed to be mobile-first, offline-capable, and multilingual.

🌟 Features

• Gamified Learning: Pokemon Red-style top-down adventure games
• Multilingual Support: English, Spanish, and Tamil with quick toggle
• Offline Access: Downloadable lessons and offline capability
• Mobile-First Design: Optimized for low-cost devices
• Dark/Light Mode: Theme toggle with proper color system
• Role-Based Access: Student, Teacher, and Admin dashboards
• PWA Support: Progressive Web App capabilities

🚀 Live Demo

Visit the live demo: https://terrificdatabytes.github.io/edugamehub1/

🛠️ Technologies Used

• Frontend: React 18, TypeScript, Vite
• Styling: Tailwind CSS v4
• Icons: Lucide React
• Components: Custom shadcn/ui components
• Deployment: GitHub Pages with GitHub Actions

🏁 Quick Start

Prerequisites

• Node.js 18 or higher
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/Terrificdatabytes/edugamehub1.git
   cd edugamehub1

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Open http://localhost:3000 in your browser.

📦 Building for Production

npm run build

🚀 Deployment

GitHub Pages (Recommended)

1. Automatic Deployment (Recommended):

   • Push your code to the main or master branch
   • GitHub Actions will automatically build and deploy your app
   • Your app will be available at https://terrificdatabytes.github.io/edugamehub1/

2. Manual Deployment:

   npm run deploy:gh-pages

Other Platforms

• Netlify: npm run deploy:netlify
• Vercel: npm run deploy:vercel
• Local Testing: npm run serve:local

⚙️ Configuration

Repository Configuration

The app is configured for the repository edugamehub1 by user Terrificdatabytes. The base path in vite.config.ts is set to:

base: process.env.NODE_ENV === 'production' && process.env.GITHUB_PAGES ? '/edugamehub1/' : './',

GitHub Pages Setup

1. Go to your repository settings: https://github.com/Terrificdatabytes/edugamehub1/settings
2. Navigate to "Pages" section in the left sidebar
3. Under "Source", select "GitHub Actions"
4. The deployment workflow will automatically deploy when you push to main/master
5. Your app will be available at: https://terrificdatabytes.github.io/edugamehub1/

Important: If you don't have a package-lock.json file, run npm install locally first to generate it, then commit it to your repository for faster CI builds.

🎮 Demo Credentials

Use these credentials to test different user roles:

• Student: student / demo123
• Teacher: teacher / demo123
• Admin: admin / demo123

📱 Offline Support

The app includes:

• Service Worker for offline caching
• Offline status indicator
• Downloadable lessons
• Lite mode for low-end devices

🌍 Multilingual Support

Supported languages:

• English (en)
• Spanish (es)
• Tamil (ta)
• Hindi (hi)

🎯 Core Modules

1. Student Dashboard: Gamified learning with progress tracking
2. Teacher Dashboard: Content management and student analytics
3. Admin Panel: User management and system configuration
4. Pokemon-style Games: Subject-specific adventure games
5. Compatibility Module: Device detection and optimization
6. Troubleshooting Module: Diagnostic tools and help system

🤝 Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m 'Add amazing feature'
4. Push to the branch: git push origin feature/amazing-feature
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built for rural education initiatives
• Optimized for low-bandwidth environments
• Designed with accessibility in mind
• Community-driven development

📞 Support

For support and questions:

• Create an issue on GitHub
• Check the troubleshooting module in the app
• Review the deployment documentation

---

Made with ❤️ for rural education