Quizlyst AI is a revolutionary learning platform that instantly transforms any content into comprehensive study materials. Whether you're a student, educator, or lifelong learner, our AI-powered system creates personalized notes, summaries, and interactive quizzes from your content in seconds.
๐ Perfect for: Students preparing for exams, educators creating course materials, professionals upskilling, and anyone who wants to learn more efficiently.
- โก Lightning Fast: Process content in under 30 seconds
- ๐ฏ Smart Learning: AI adapts to your learning style
- ๐ฑ Always Available: Works on any device, anywhere
- ๐ Global Ready: Multi-language support included
- ๐ Privacy First: Your content stays secure
|
|
- ๐จ Modern UI: Clean, intuitive interface
- ๐ฑ Responsive Design: Perfect on mobile & desktop
- ๐ Dark/Light Mode: Choose your preference
- โก Real-time Processing: Live progress updates
โ
Node.js 18+ installed
โ
OpenRouter API key (primary)
โ
Cohere API key (optional fallback)# 1๏ธโฃ Clone the repository
git clone https://github.com/Hanzlase/QuizlystAI.git
cd quizlystai
# 2๏ธโฃ Install dependencies
npm install
# 3๏ธโฃ Set up environment variables
cp .env.example .env
# Edit .env with your API keys
# 4๏ธโฃ Start development server
npm run dev
# 5๏ธโฃ Open in browser
# Navigate to http://localhost:5000Create a .env file in the root directory:
# Required
API_KEY=your_openrouter_api_key_here
# Optional (fallback)
COHERE_KEY=your_cohere_api_key_here
# Server Configuration
PORT=5000
NODE_ENV=development|
๐ Upload Files PDF, DOCX, TXT Up to 10MB |
๐ Paste URLs Articles, blogs, docs Any website |
๐บ YouTube Videos Educational content With transcripts |
- ๐ Note Styles: Simple explanations or detailed analysis
- ๐ฏ Custom Instructions: "Explain like I'm 5" or "Focus on key formulas"
- ๐ Language: Translate to your preferred language
- ๐ Quiz Settings: Choose difficulty and question count
- ๐ Study Notes: Comprehensive, markdown-formatted notes
- ๐ Smart Summary: Key concepts in 2-3 sentences
- ๐ฏ Interactive Quiz: Test your knowledge immediately
POST /api/content/process
Content-Type: application/json
{
"url": "https://example.com/article",
"type": "link",
"mode": "simple",
"customPrompt": "Focus on main concepts"
}POST /api/content/upload
Content-Type: multipart/form-data
// FormData with file and processing optionsPOST /api/quiz/generate
Content-Type: application/json
{
"difficulty": "medium",
"questionCount": 10,
"focusAreas": ["key concepts", "definitions"]
}GET /api/health
// Response
{
"status": "ok",
"timestamp": "2024-01-01T00:00:00.000Z",
"environment": "vercel",
"hasApiKey": true
}quizlyst-ai/
โโโ ๐ public/ # Frontend assets
โ โโโ ๐จ css/
โ โ โโโ home.css # Responsive styling
โ โโโ โก js/
โ โ โโโ home.js # Interactive features
โ โโโ ๐ home.html # Main interface
โโโ ๐ uploads/ # Temp file storage (local)
โโโ ๐ server.js # Express server & API
โโโ ๐ฆ package.json # Dependencies & scripts
โโโ โ๏ธ vercel.json # Deployment config
โโโ ๐ README.md # You are here!
- ๐ฏ Content Extraction: Multi-format processing with error handling
- ๐ค AI Integration: Dual API support with automatic fallback
- ๐ฑ Responsive UI: Mobile-first design with modern CSS
- โก Real-time Updates: Live processing status and progress bars
- ๐ Translation: Built-in multi-language support
# Quick deploy
npm i -g vercel
vercel
# Set environment variables in Vercel dashboard:
# API_KEY, COHERE_KEY# Coming soon - Docker support
FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
EXPOSE 5000
CMD ["npm", "start"]- Heroku: Add
Procfilewithweb: node server.js - Railway: Connect GitHub repo directly
- DigitalOcean: Use App Platform with Node.js preset
| Variable | Description | Required | Default |
|---|---|---|---|
API_KEY |
OpenRouter API key | โ Yes | - |
COHERE_KEY |
Cohere API key (fallback) | - | |
PORT |
Server port | โ No | 5000 |
NODE_ENV |
Environment mode | โ No | development |
VERCEL |
Vercel environment flag | ๐ค Auto-set | - |
| Type | Extensions | Max Size | Notes |
|---|---|---|---|
| Documents | .pdf, .docx, .txt |
10MB | Text extraction optimized |
| Web Content | Any URL | - | Smart content detection |
| Videos | YouTube URLs | - | Requires captions/transcripts |
- Primary: Qwen 3 235B (OpenRouter) - High quality, fast
- Fallback: Command R+ (Cohere) - Reliable backup
- Timeout: 50 seconds per request
- Temperature: 0.4 (balanced creativity/accuracy)
We love contributions! Here's how to get started:
- Check existing issues
- Create a new issue with detailed description
- Include steps to reproduce
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Make your changes with tests
- Commit:
git commit -m 'Add amazing feature' - Push:
git push origin feature/amazing-feature - Open a Pull Request
- Follow existing code style
- Add comments for complex logic
- Test on both desktop and mobile
- Update documentation if needed
- Web Articles: ~15-30 seconds
- PDF Documents: ~20-45 seconds
- YouTube Videos: ~10-25 seconds
- Text Content: 10,000 characters (auto-truncated)
- File Size: 10MB maximum
- Quiz Questions: 1-50 per generation
- OpenRouter: Varies by plan
- Cohere: 1000 requests/month (free tier)
- Automatic Fallback: Seamless switching between APIs
๐ "API authentication failed"
- Check your API keys in
.envfile - Verify keys are valid and have sufficient credits
- Ensure no extra spaces in environment variables
โฑ๏ธ "Processing timeout"
- Try with shorter content (under 10,000 characters)
- Check your internet connection
- Verify API service status
๐ "File upload failed"
- Ensure file is under 10MB
- Check file format (PDF, DOCX, TXT only)
- Try uploading from local environment (not Vercel)
# Enable detailed logging
NODE_ENV=development npm run dev
# Check API health
curl http://localhost:5000/api/health- ๐จ Custom Themes: Personalize your interface
- ๐ Learning Analytics: Track your progress
- ๐ฅ Team Collaboration: Share study materials
- ๐ Batch Processing: Handle multiple files
- ๐ฑ Mobile App: Native iOS/Android apps
- ๐ LMS Integration: Canvas, Moodle support
- ๐ง Adaptive Learning: AI that learns your style
- ๐ฎ Gamification: Points, badges, leaderboards
- ๐ Audio Generation: Text-to-speech notes
- ๐ Handwriting Recognition: Process handwritten notes
- ๐ Offline Mode: Work without internet
This project is licensed under the MIT License - see the LICENSE file for details.
- โ Commercial use allowed
- โ Modification allowed
- โ Distribution allowed
- โ Private use allowed
- โ No warranty provided
๐ค OpenRouter - Primary AI model access
๐ง Cohere - Reliable AI fallback
โก Vercel - Seamless deployment platform
๐ Open Source Community - Amazing libraries and tools
The Quizlyst Team - Passionate about making learning accessible to everyone