A real-time interactive classroom application built with React, Vite, and Convex. Create live polling sessions with polls, quizzes, timers, and more for your classroom or presentation.

• 🎯 Interactive Elements: Create polls, multiple choice questions, true/false questions, and text responses
• ⏱️ Timers: Built-in countdown timers for activities
• 👥 Real-time Participation: Students join with simple session codes
• 📊 Live Results: See responses update in real-time
• 🔐 Secure Authentication: Anonymous authentication via Convex Auth
• 📱 Responsive Design: Works on desktop, tablet, and mobile

• Frontend: React 19, Vite, TailwindCSS
• Backend: Convex (serverless backend with real-time database)
• Hosting: Vercel (frontend) + Convex (backend)
• Authentication: Convex Auth

• Node.js 20+
• npm or yarn
• A Convex account (free tier available)
• A Vercel account (free tier available)

1. Clone the repository

   git clone https://github.com/JonasWeinert/PollUP.git
   cd PollUP

2. Install dependencies

   npm install

3. Set up Convex

   npx convex dev

   This will:

   • Prompt you to log in to Convex
   • Create a new project (or link to existing)
   • Generate .env.local with your development deployment URL
   • Start the Convex dev server

4. Run the development server

   npm run dev

   This starts both the frontend (Vite) and backend (Convex) in development mode.

5. Open your browser

   • Navigate to http://localhost:5173
   • The app should be running with hot reload enabled

├── src/
│   ├── components/          # React components
│   ├── lib/                 # Utility functions
│   └── main.tsx            # App entry point
├── convex/
│   ├── schema.ts           # Database schema
│   ├── sessions.ts         # Session management functions
│   ├── elements.ts         # Interactive element functions
│   ├── responses.ts        # Response handling functions
│   └── auth.ts             # Authentication configuration
├── public/                 # Static assets
└── dist/                   # Build output (generated)

1. Generate a production deploy key

   • Go to Convex Dashboard
   • Select your project
   • Navigate to Settings → Deploy Keys
   • Click Generate a deploy key for Production
   • Copy the key (starts with prod:...)

2. Deploy to production

   npx convex deploy

1. Connect your GitHub repository to Vercel

   • Go to Vercel Dashboard
   • Click Add New → Project
   • Import your GitHub repository
   • Vercel will auto-detect it as a Vite project

2. Configure environment variables in Vercel

   • In your Vercel project settings
   • Go to Settings → Environment Variables
   • Add the following:

   Variable Name	Value	Environment
   CONVEX_DEPLOY_KEY	Your production deploy key from Step 1	Production, Preview, Development
   VITE_CONVEX_URL	Your Convex production URL (e.g., https://your-project.convex.cloud)	Production, Preview, Development

3. Deploy

   • Click Deploy in Vercel
   • Your app will be live at https://your-project.vercel.app

Every push to the main branch automatically triggers deployment:

git add .
git commit -m "Your changes"
git push origin main

What happens automatically:

1. ✅ Vercel detects the push via GitHub integration
2. ✅ Runs npx convex deploy (deploys backend, generates API files)
3. ✅ Runs npm run build (builds frontend)
4. ✅ Deploys to production

No manual deployment needed! 🚀

If you need to deploy manually:

First-time setup:

./deploy.sh

Subsequent deployments:

./redeploy.sh

Deploy only backend:

npm run deploy:backend

Deploy only frontend:

npm run deploy:frontend

This is a side project born out of frustration with propietary solutions like Mentimeter. Contributionsare very welcome! Here's how to get started:

1. Fork the repository

   • Click the "Fork" button on GitHub
   • Clone your fork locally

2. Create a feature branch

   git checkout -b feature/your-feature-name

3. Make your changes

   • Write clean, well-documented code
   • Follow the existing code style
   • Test your changes locally

4. Commit your changes

   git add .
   git commit -m "feat: Add your feature description"

5. Push to your fork

   git push origin feature/your-feature-name

6. Open a Pull Request

   • Go to the original repository
   • Click "New Pull Request"
   • Select your branch
   • Describe your changes clearly

Follow Conventional Commits:

• feat: - New feature
• fix: - Bug fix
• docs: - Documentation changes
• style: - Code style changes (formatting, etc.)
• refactor: - Code refactoring
• test: - Adding or updating tests
• chore: - Maintenance tasks

Examples:

git commit -m "feat: Add timer pause functionality"
git commit -m "fix: Resolve participant disconnect issue"
git commit -m "docs: Update deployment instructions"

• TypeScript: Use proper typing, avoid any
• React: Use functional components and hooks
• Convex: Follow Convex best practices
• Formatting: Run npm run lint before committing

• Test all features locally with npm run dev
• Verify builds work with npm run build
• Test in different browsers and screen sizes
• For backend changes, test with multiple concurrent users

Good PR practices:

• ✅ Clear, descriptive title
• ✅ Detailed description of changes
• ✅ Reference related issues (e.g., "Fixes #123")
• ✅ Screenshots/GIFs for UI changes
• ✅ Keep changes focused and atomic
• ✅ Ensure CI passes (if configured)

Before submitting:

• Code builds successfully (npm run build)
• No console errors or warnings
• Tested locally in dev and production mode
• Updated documentation if needed
• Followed commit message guidelines

"Could not resolve convex/_generated/api"

• Ensure CONVEX_DEPLOY_KEY is set in Vercel
• Check that Convex deployment succeeded
• Verify convex/_generated/ folder exists locally (run npx convex dev)

"Authentication failed"

• Verify your Convex deploy key is correct
• Ensure it's set for the correct environment (Production/Preview)
• Regenerate the key if needed

Changes not reflecting

• Check that npm run dev is running
• Ensure npx convex dev is running in the background
• Clear browser cache and reload

Database issues

• Check Convex Dashboard for errors
• Verify schema matches your code in convex/schema.ts
• Run npx convex dev to sync schema

• Convex Documentation: https://docs.convex.dev
• Vite Documentation: https://vitejs.dev
• React Documentation: https://react.dev
• TailwindCSS: https://tailwindcss.com

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

• 🐛 Found a bug? Open an issue
• 💡 Have a feature request? Start a discussion
• 💬 Questions? Check the documentation or ask in discussions

Vibe coded with ❤️ for educators and presenters