Clone
README.md
Blame History Raw Edit 3.6 KB

Quiz Craft

Create and take AI-generated assessments with ease

Quiz Craft is a Vue.js web application that enables users to create, upload, and take custom assessments. It features built-in 9th-grade readiness assessments and supports AI-generated quizzes through a simple copy-paste workflow.

๐ŸŒŸ Features

  • Pre-built Assessments: Ready-to-use 9th-grade assessments covering History, Geography, Science, Math, and Language Arts
  • AI Integration: Built-in prompts for generating assessments with ChatGPT, Claude, or other AI assistants
  • Multiple Input Methods: Upload JSON files or paste JSON directly
  • Paginated Interface: Questions displayed 5 per page for better user experience
  • Progress Tracking: Visual progress bar and question counter
  • Comprehensive Scoring: Total score plus subject-by-subject breakdown
  • Local Storage: Uploaded assessments persist across sessions
  • Responsive Design: Works on desktop and mobile devices

๐Ÿš€ Live Demo

Visit quiz-craft.example.com (update with your deployed URL)

๐Ÿ› ๏ธ Technology Stack

  • Vue 3 with Composition API
  • Vite for fast development and building
  • Vue Router for navigation
  • LocalStorage for data persistence
  • Cloudflare Pages ready

๐Ÿ“ฆ Installation

# Clone the repository
git clone https://github.com/toreyheinz/quiz-craft.git
cd quiz-craft
# Install dependencies
npm install
# Start development server
npm run dev

๐Ÿ—๏ธ Building for Production

# Build for production
npm run build
# Preview production build
npm run preview

โ˜๏ธ Deployment

Cloudflare Pages

  1. Push your code to GitHub
  2. Connect your GitHub repository to Cloudflare Pages
  3. Set build configuration:
    • Build command: npm run build
    • Build output directory: dist
    • Root directory: /

Other Platforms

The built files in dist/ can be deployed to any static hosting service.

๐Ÿ“ Creating Custom Assessments

Method 1: Using AI

  1. Go to the "AI Guide" tab
  2. Copy one of the example prompts
  3. Paste into your favorite AI chat (ChatGPT, Claude, etc.)
  4. Copy the generated JSON
  5. Paste into the "Paste JSON" tab

Method 2: Manual Creation

Create a JSON file following this structure:

{
"title": "Your Assessment Title",
"description": "Brief description",
"subjects": [
{
"name": "Subject Name",
"questions": [
{
"id": 1,
"question": "Question text?",
"options": ["Option A", "Option B", "Option C", "Option D"],
"correctAnswer": 0
}
]
}
]
}

Important Notes:

  • correctAnswer uses 0-based indexing (0 = first option, 1 = second, etc.)
  • Each question must have exactly 4 options
  • Question IDs must be unique numbers

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

๐Ÿ“„ License

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

๐Ÿ™ Acknowledgments

  • Built with Vue.js and Vite
  • Inspired by the need for easy assessment creation
  • Thanks to all contributors

๐Ÿ“ง Contact

Torey Heinz - GitHub

Project Link: https://github.com/toreyheinz/quiz-craft