Quiz Bank 🧠

A simple Flutter package for true/false quiz questions. Perfect for educational apps, trivia games, and learning platforms.

✨ Features

• 🎯 Easy to Use - Simple API with just a few lines of code
• 📚 Built-in Questions - 20+ questions across different categories
• 🎚️ Difficulty Levels - Easy to hard questions
• 🔄 Quiz Management - Navigate questions, track scores, shuffle
• ➕ Custom Questions - Add your own questions

📸 Demo

🚀 Quick Start

1. Install the package

Option A: Using flutter pub add (recommended)

flutter pub add quiz_bank

Option B: Add to pubspec.yaml

dependencies:
  quiz_bank: ^1.0.0

2. Basic Usage

import 'package:quiz_bank/quiz_bank.dart';

void main() {
  // Create a quiz
  final quiz = QuizBrain();
  
  // Get question and answer
  print(quiz.questionText);      // "Some cats are actually allergic to humans"
  print(quiz.correctAnswer);     // true
  
  // Check if user's answer is correct
  bool userAnswer = true;
  bool isCorrect = quiz.checkAnswer(userAnswer);  // true
  
  // Move to next question
  quiz.nextQuestion();
}

3. Simple Quiz App

class MyQuizApp extends StatefulWidget {
  @override
  _MyQuizAppState createState() => _MyQuizAppState();
}

class _MyQuizAppState extends State<MyQuizApp> {
  QuizBrain quiz = QuizBrain();
  int score = 0;

  void _answerQuestion(bool answer) {
    if (quiz.checkAnswer(answer)) {
      score++;
    }
    quiz.nextQuestion();
    setState(() {});
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Column(
        children: [
          Text(quiz.questionText),
          ElevatedButton(
            onPressed: () => _answerQuestion(true),
            child: Text('TRUE'),
          ),
          ElevatedButton(
            onPressed: () => _answerQuestion(false),
            child: Text('FALSE'),
          ),
          Text('Score: $score'),
        ],
      ),
    );
  }
}

📱 Example App

Check out the example/ directory for a complete, simple quiz app that shows how to use the package.

🎯 More Features

📚 Question Categories

Get questions from specific topics:

// Science questions only
final scienceQuiz = QuizBrain.fromCategory('Science');

// Technology questions
final techQuiz = QuizBrain.fromCategory('Technology');

// Geography questions  
final geoQuiz = QuizBrain.fromCategory('Geography');

Available categories: Science, Technology, Geography, History, Nature, Sports, Entertainment, Food, Health, General

🎚️ Difficulty Levels

Choose how hard you want the questions:

// Easy questions (Level 1)
final easyQuiz = QuizBrain.fromDifficulty(1);

// Medium questions (Level 3)
final mediumQuiz = QuizBrain.fromDifficulty(3);

// Hard questions (Level 5)
final hardQuiz = QuizBrain.fromDifficulty(5);

Difficulty levels: 1 (Easy) to 5 (Hard)

🔀 Quiz Controls

Navigate and manage your quiz:

quiz.nextQuestion();        // Go to next question
quiz.previousQuestion();    // Go back to previous question  
quiz.randomQuestion();      // Jump to random question
quiz.shuffleQuestions();    // Mix up all questions
quiz.reset();              // Start over from beginning

➕ Custom Questions

Add your own questions:

// Create quiz with your questions
final myQuiz = QuizBrain(questions: [
  Question(text: 'Is Flutter awesome?', answer: true),
  Question(text: 'Dart is easy to learn?', answer: true),
]);

// Add questions to existing quiz
quiz.addQuestion(Question(text: 'New question?', answer: false));

📊 Quiz Information

Get details about your quiz:

print('Total questions: ${quiz.totalQuestions}');
print('Current question: ${quiz.currentQuestionNumber}');
print('Is finished: ${quiz.isFinished}');
print('Has next question: ${quiz.hasNextQuestion}');

🏷️ Question Details

Get extra information about the current question:

// Basic question info
print('Question: ${quiz.questionText}');
print('Answer: ${quiz.correctAnswer}');

// Extra details (if available)
print('Category: ${quiz.currentCategory}');        // e.g., "Science"
print('Difficulty: ${quiz.currentDifficulty}');    // e.g., 3
print('Explanation: ${quiz.currentExplanation}');  // e.g., "Because..."
print('Source: ${quiz.currentSource}');            // e.g., "Wikipedia"

🎯 Combine Features

Mix and match different features:

// Easy science questions only
final easyScienceQuiz = QuizBrain.fromCategoryAndDifficulty('Science', 1);

// Shuffle all questions
final shuffledQuiz = QuizBrain(shuffle: true);

// Custom questions with categories
final customQuiz = QuizBrain(questions: [
  Question(
    text: 'Is Flutter cross-platform?', 
    answer: true,
    category: 'Technology',
    difficulty: 2,
    explanation: 'Flutter works on iOS, Android, Web, and Desktop!',
  ),
]);

📚 API Reference

Main Methods

Method	Description
QuizBrain()	Create a new quiz
quiz.questionText	Get current question
quiz.correctAnswer	Get correct answer (true/false)
quiz.checkAnswer(answer)	Check if answer is correct
quiz.nextQuestion()	Go to next question
quiz.isFinished	Check if quiz is done
quiz.totalQuestions	Get total number of questions

🔄 Upgrading from 0.0.2

Your existing code works with zero changes! Just update the version number:

dependencies:
  quiz_bank: ^1.0.0  # was ^0.0.2

Your old code still works:

QuizBrain quiz_brain = QuizBrain();
quiz_brain.RandomQuestion();
String text = quiz_brain.getQuestionText();

But you can also use the new API:

QuizBrain quiz = QuizBrain();
quiz.randomQuestion();
String text = quiz.questionText;

🤝 Contributing

Found a bug or want to add a feature? Open an issue or submit a pull request!

📄 License

MIT License - see LICENSE file for details.

---

Made with ❤️ by Binni G.