An interactive quantum physics education platform that makes complex quantum mechanics accessible through gamified 3D experiences.
Prerequisites: Node.js 18+, npm 9+ (Installation Guide)
# Clone and setup
git clone https://github.com/Project-Qplay/QPlay-Core.git
cd QPlay-Core
# Install dependencies
npm run install:all
# Start development server
npm run devAccess your app at: http://localhost:8888
🔧 Having installation issues? See our Complete Installation Guide
- Interactive Quantum Rooms: Superposition, Entanglement, Tunneling
- 3D Visualizations: Three.js quantum physics simulations
- Serverless Backend: 7 Netlify Functions for scalability
- Modern Auth: Supabase + Google OAuth integration
- Gamification: Achievements, leaderboards, progress tracking
- Frontend: React 18, TypeScript, Three.js, Vite, Tailwind CSS
- Backend: Netlify Functions (serverless)
- Database: Supabase (PostgreSQL)
- Authentication: Supabase Auth + Google OAuth
- Deployment: Netlify
| Endpoint | Method | Description |
|---|---|---|
/auth-login |
POST | Email-based login |
/auth-signup |
POST | User registration |
/auth-google |
POST | Google OAuth sign-in |
/game-session |
POST | Start/save/complete game sessions |
/leaderboard |
GET | Fetch score/speed leaderboards |
/achievements |
POST | Unlock achievements |
/quantum-measurements |
POST | Log quantum measurements |
{
"dev": "netlify dev",
"preview": "cd apps/web && npm run preview",
"install:all": "cd apps/web && npm install && cd ../../netlify/functions && npm install"
}QPlay-Core/
├── 🎨 apps/web/ # React frontend (300MB+ node_modules)
├── ⚡ netlify/functions/ # Serverless backend (7 functions)
│ ├── auth-login.js # Email login
│ ├── auth-signup.js # User registration
│ ├── auth-google.js # Google OAuth
│ ├── game-session.js # Game state management
│ ├── leaderboard.js # Leaderboard queries
│ ├── achievements.js # Achievement tracking
│ ├── quantum-measurements.js # Quantum data logging
│ └── utils/ # Shared utilities (cors, supabase, validation)
├── 🔧 .env # Environment variables
├── 📄 netlify.toml # Netlify deployment config
├── 📚 Project_documentation.md # Complete documentation
└── 🔧 Installation_guide.md # Installation & troubleshooting
- Node.js: 18.0.0+ (LTS recommended)
- npm: 9.0.0+ (included with Node.js)
- Git: 2.30.0+
- RAM: 4GB minimum (8GB recommended)
- Storage: 2GB free space for dependencies
👉 Read the Full Documentation 👈
The comprehensive documentation includes:
- 🏗️ Architecture Overview - Monorepo structure and data flow
- 🔧 Technical Setup - Environment variables, authentication
- 📁 Project Structure - Detailed file organization
- 🛠️ Development Workflow - Commands, debugging, best practices
- 🚀 Deployment Guide - Production deployment to Netlify
- 🐛 Troubleshooting - Common issues and solutions
- 📚 Full Documentation - Complete setup and development guide
- 🔧 Installation Guide - Step-by-step installation & troubleshooting
- 🌐 Live Demo - Try it now!
- 📊 Project Status: Active development
- 🤝 Contributing: See documentation for guidelines
- Check prerequisites (Node.js 18+, npm 9+)
- Read the Installation Guide if you encounter issues
- Configure authentication (Google OAuth + Supabase)
- Run
npm run devto start developing - Visit http://localhost:8888 to see your quantum physics game!
🚀 Ready to explore quantum physics through interactive learning? Let's build the future of education! ⚛️🎮
- Cat 3D model: LowPoly Cat Rig + Run Animation by Omabuarts Studio
For detailed setup, troubleshooting, and development guides, see Project_documentation.md and Installation_guide.md