Skip to content

Hanzlase/QuizlystAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

19 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿง  QUIZLYST AI

Transform Any Content Into Learning Gold

Live Demo GitHub Stars License

Node.js Express.js JavaScript Vercel


๐ŸŽฏ What is Quizlyst AI?

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.

๐ŸŒŸ Why Choose Quizlyst AI?

  • โšก 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

โœจ Powerful Features

๐Ÿ“š Content Processing

  • ๐Ÿ“„ Documents: PDF, DOCX, TXT files
  • ๐ŸŒ Web Articles: Any URL or blog post
  • ๐Ÿ“บ YouTube Videos: Extract from transcripts
  • ๐Ÿ“Š Smart Extraction: AI-powered content analysis

๐Ÿค– AI-Powered Generation

  • ๐Ÿ“ Study Notes: Comprehensive, well-structured
  • ๐Ÿ“‹ Smart Summaries: Key concepts highlighted
  • ๐ŸŽฏ Interactive Quizzes: Multiple difficulty levels
  • ๐ŸŒ Translation: 50+ languages supported

๐ŸŽจ User Experience

  • ๐ŸŽจ Modern UI: Clean, intuitive interface
  • ๐Ÿ“ฑ Responsive Design: Perfect on mobile & desktop
  • ๐ŸŒ™ Dark/Light Mode: Choose your preference
  • โšก Real-time Processing: Live progress updates

๐Ÿ› ๏ธ Technology Stack

Backend Powerhouse

Express.js Node.js JavaScript

AI & Processing

OpenRouter Cohere Cheerio

Frontend Excellence

HTML5 CSS3 Chart.js

Deployment & Tools

Vercel Multer PDF Parse


๐Ÿš€ Quick Start Guide

๐Ÿ“‹ Prerequisites

โœ… Node.js 18+ installed
โœ… OpenRouter API key (primary)
โœ… Cohere API key (optional fallback)

โšก Installation

# 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:5000

๐Ÿ”‘ Environment Setup

Create 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

๐Ÿ“– How to Use

๐ŸŽฏ Step 1: Choose Your Content

Documents
๐Ÿ“„ Upload Files
PDF, DOCX, TXT
Up to 10MB
Web
๐Ÿ”— Paste URLs
Articles, blogs, docs
Any website
YouTube
๐Ÿ“บ YouTube Videos
Educational content
With transcripts

๐ŸŽจ Step 2: Customize Your Learning

  • ๐Ÿ“ 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

๐Ÿš€ Step 3: Get Your Materials

  • ๐Ÿ“š Study Notes: Comprehensive, markdown-formatted notes
  • ๐Ÿ“‹ Smart Summary: Key concepts in 2-3 sentences
  • ๐ŸŽฏ Interactive Quiz: Test your knowledge immediately

๐Ÿ”Œ API Reference

Content Processing

POST /api/content/process
Content-Type: application/json

{
  "url": "https://example.com/article",
  "type": "link",
  "mode": "simple",
  "customPrompt": "Focus on main concepts"
}

File Upload (Local Development Only)

POST /api/content/upload
Content-Type: multipart/form-data

// FormData with file and processing options

Quiz Generation

POST /api/quiz/generate
Content-Type: application/json

{
  "difficulty": "medium",
  "questionCount": 10,
  "focusAreas": ["key concepts", "definitions"]
}

Health Check

GET /api/health

// Response
{
  "status": "ok",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "environment": "vercel",
  "hasApiKey": true
}

๐Ÿ—๏ธ Project Architecture

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!

๐Ÿ”ง Key Components

  • ๐ŸŽฏ 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

๐ŸŒ Deployment Options

๐Ÿš€ Vercel (Recommended)

Deploy with Vercel

# Quick deploy
npm i -g vercel
vercel

# Set environment variables in Vercel dashboard:
# API_KEY, COHERE_KEY

๐Ÿณ Docker

# Coming soon - Docker support
FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
EXPOSE 5000
CMD ["npm", "start"]

โ˜๏ธ Other Platforms

  • Heroku: Add Procfile with web: node server.js
  • Railway: Connect GitHub repo directly
  • DigitalOcean: Use App Platform with Node.js preset

โš™๏ธ Configuration Guide

๐Ÿ”‘ Environment Variables

Variable Description Required Default
API_KEY OpenRouter API key โœ… Yes -
COHERE_KEY Cohere API key (fallback) โš ๏ธ Recommended -
PORT Server port โŒ No 5000
NODE_ENV Environment mode โŒ No development
VERCEL Vercel environment flag ๐Ÿค– Auto-set -

๐Ÿ“ Supported File Types

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

๐ŸŽฏ AI Model Configuration

  • 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)

๐Ÿค Contributing

We love contributions! Here's how to get started:

๐Ÿ› Found a Bug?

  1. Check existing issues
  2. Create a new issue with detailed description
  3. Include steps to reproduce

โœจ Want to Add a Feature?

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

๐Ÿ“ Development Guidelines

  • Follow existing code style
  • Add comments for complex logic
  • Test on both desktop and mobile
  • Update documentation if needed

๐Ÿ“Š Performance & Limits

โšก Processing Speed

  • Web Articles: ~15-30 seconds
  • PDF Documents: ~20-45 seconds
  • YouTube Videos: ~10-25 seconds

๐Ÿ“ Content Limits

  • Text Content: 10,000 characters (auto-truncated)
  • File Size: 10MB maximum
  • Quiz Questions: 1-50 per generation

๐Ÿ”„ API Rate Limits

  • OpenRouter: Varies by plan
  • Cohere: 1000 requests/month (free tier)
  • Automatic Fallback: Seamless switching between APIs

๐Ÿ†˜ Troubleshooting

โŒ Common Issues

๐Ÿ”‘ "API authentication failed"
  • Check your API keys in .env file
  • 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)

๐Ÿ”ง Debug Mode

# Enable detailed logging
NODE_ENV=development npm run dev

# Check API health
curl http://localhost:5000/api/health

๐Ÿ“ˆ Roadmap

๐ŸŽฏ Coming Soon

  • ๐ŸŽจ 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

๐Ÿš€ Future Vision

  • ๐Ÿง  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

๐Ÿ“œ License

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

๐ŸŽฏ What this means:

  • โœ… Commercial use allowed
  • โœ… Modification allowed
  • โœ… Distribution allowed
  • โœ… Private use allowed
  • โŒ No warranty provided

๐Ÿ™ Acknowledgments

Special Thanks To:

๐Ÿค– OpenRouter - Primary AI model access
๐Ÿง  Cohere - Reliable AI fallback
โšก Vercel - Seamless deployment platform
๐Ÿ“š Open Source Community - Amazing libraries and tools

Built With Love By:

The Quizlyst Team - Passionate about making learning accessible to everyone


๐Ÿ“ž Get Help & Support

Need Help? We're Here!

Email Support GitHub Issues Documentation

Community

Discord Twitter


โญ Star this repo if you found it helpful!

GitHub Stars GitHub Forks GitHub Watchers

Made with โค๏ธ for learners everywhere

Transform your learning journey today with Quizlyst AI

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors