🚀 PythonPal - Your AI Coding Companion

Welcome to PythonPal's frontend! Where learning Python becomes as fun as playing with a pet snake (but safer! 🐍)

✨ Features

• 🤖 AI-Powered Chat Tutor
• 🎯 Interactive Quizzes with Real-time Feedback
• 🎮 Voice Command Support
• 🏆 Achievement System
• 📊 Progress Tracking
• 🌈 Beautiful UI with Animations
• 🌙 Dark/Light Mode
• 🔊 Sound Effects
• 📱 Responsive Design

🛠️ Setup

1. Clone this repo:

git clone https://github.com/CodeMaverick2/pythonpal

2. Install dependencies:

npm install

3. Create a .env file:

REACT_APP_BACKEND_URL=your_backend_url  # e.g., https://pythonpal-api.herokuapp.com

4. Start the development server:

npm start

🌐 Deployment

Deploying to Vercel:

1. Push your code to GitHub
2. Connect your repo to Vercel
3. Add environment variables in Vercel dashboard
4. Deploy! 🚀

Deploying to Netlify:

1. Push to GitHub
2. Connect repo to Netlify
3. Configure build settings:
   • Build command: npm run build
   • Publish directory: build
4. Add environment variables
5. Hit deploy! 🎉

🔗 Important URLs

• Frontend: Your deployed frontend URL (e.g., https://pythonpal.vercel.app)
• Backend: Your backend API URL
• Make sure CORS is configured in backend to allow your frontend URL!

🎨 Customization

• Theme colors in src/theme.js
• Quiz configs in src/config/moduleConfigs.js
• Sound effects in src/utils/audio.js

🐛 Troubleshooting

• "Backend not responding": Check BACKEND_URL in .env
• "CORS error": Add your frontend URL to backend's allowed origins
• "Blank screen": Check console for JavaScript errors
• "No sound": Check if browser allows audio playback

🤝 Contributing

Found a bug? Want to add a feature? PRs welcome! Just keep it fun and friendly! 😊

📝 Note

Remember to update the BACKEND_URL in your environment variables when deploying. Your frontend needs to know where to find its backend buddy! 🤝

🎉 Happy Coding!

May your code be bug-free and your deployments smooth! 🚀

```markdown:backend/README.md
# 🎮 PythonPal Backend - The Brain Behind the Magic

Welcome to the server-side of PythonPal! Where all the magic happens behind the curtain! 🎩✨

## 🛠️ Tech Stack
- Node.js & Express
- MongoDB
- JWT Authentication
- OpenAI Integration
- WebSocket for Real-time Features

## 🚀 Quick Start

1. Clone the repo:
```bash
git clone <your-repo-url>
cd backend

2. Install dependencies:

npm install

3. Create a .env file:

PORT=5000
MONGODB_URI=your_mongodb_uri
JWT_SECRET=your_super_secret_key
OPENAI_API_KEY=your_openai_key
FRONTEND_URLS=http://localhost:3000,https://your-deployed-frontend.com

4. Start the server:

# Development
npm run dev

# Production
npm start

🌐 Deployment

Deploying to Heroku:

1. Create Heroku app
2. Add environment variables in Heroku dashboard
3. Connect GitHub repo
4. Deploy! 🚀

Deploying to Railway:

1. Connect GitHub repo
2. Add environment variables
3. Let Railway handle the rest! 🎉

🔑 Environment Variables

• PORT: Server port (default: 5000)
• MONGODB_URI: MongoDB connection string
• JWT_SECRET: Secret for JWT tokens
• OPENAI_API_KEY: Your OpenAI API key
• FRONTEND_URLS: Comma-separated frontend URLs for CORS

📡 API Endpoints

🔐 Auth Routes

• POST /api/auth/register: Register new user
• POST /api/auth/login: Login user
• GET /api/auth/profile: Get user profile

🤖 Tutor Routes

• POST /api/tutor/chat: Get AI tutor response
• POST /api/tutor/generate-quiz: Generate quiz question
• POST /api/tutor/check-answer: Check quiz answer

🔒 Security Features

• CORS protection
• Rate limiting
• JWT authentication
• Request validation
• Error handling

🐛 Troubleshooting

• "MongoDB connection failed": Check MONGODB_URI
• "CORS error": Verify FRONTEND_URLS includes your frontend domain
• "OpenAI error": Check OPENAI_API_KEY
• "JWT error": Verify JWT_SECRET is set