costudy Svelte Themes

Costudy

A study app made using svelte

Here’s a README.md file for your app. It provides an overview of the project, instructions for setup, and details about features and usage.


COSTUDY Quiz App πŸŽ“

Welcome to COSTUDY, an interactive quiz app designed to test your knowledge of computer architecture! This app features a dynamic quiz experience with timers, animations, sound effects, and confetti celebrations for correct answers.


Features ✨

  • Interactive Quiz: Answer multiple-choice questions with a timer for each question.
  • Real-Time Feedback: Get instant feedback on whether your answer is correct or incorrect.
  • Score Tracking: Track your correct and incorrect answers throughout the quiz.
  • Confetti Animation: Celebrate correct answers with a fun confetti animation.
  • Sound Effects: Play sound effects for correct and incorrect answers.
  • Progress Bar: Visualize your progress through the quiz.
  • Responsive Design: Works seamlessly on desktop and mobile devices.
  • Restart Quiz: Easily restart the quiz to try again.

Technologies Used πŸ› οΈ

  • Svelte: A modern JavaScript framework for building user interfaces.
  • Svelte Confetti: A library for adding confetti animations.
  • CSS: Custom styles for a modern and visually appealing design.
  • JavaScript: Logic for quiz functionality, timers, and animations.
  • Fetch API: Load quiz questions from an external API.

Setup Instructions πŸš€

Prerequisites

  • Node.js and npm installed on your machine.

Steps

  1. Clone the Repository:

    git clone https://github.com/Unrealrojo234/costudy
    cd costudy
    
  2. Install Dependencies:

    npm install
    
  3. Run the App:

    npm run dev
    
  4. Open in Browser: Visit http://localhost:5173 (or the port specified in your terminal) to view the app.


Usage πŸ“–

  1. Start the Quiz:

    • Once the app loads, the quiz will begin automatically.
    • Each question has a 15-second timer.
  2. Answer Questions:

    • Select an option by clicking on it.
    • You’ll receive instant feedback on whether your answer is correct or incorrect.
  3. Track Your Progress:

    • The progress bar at the top shows how far you’ve progressed in the quiz.
    • Your score (correct and incorrect answers) is displayed below the question.
  4. Complete the Quiz:

    • After answering all questions, you’ll see your final score.
    • Click the Restart Quiz button to try again.

Customization 🎨

  • Change Quiz Topic:

    • Update the computerArchitecture URL in the script to fetch questions from a different API.
  • Add More Questions:

    • Modify the API response or use a local JSON file with your own questions.
  • Customize Styles:

    • Edit the style section in the Svelte file to change colors, fonts, or animations.

Screenshots πŸ“Έ


Contributing 🀝

Contributions are welcome! If you’d like to improve this project, follow these steps:

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

License πŸ“œ

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


Acknowledgments πŸ™


Enjoy the quiz! πŸŽ‰
If you have any questions or feedback, feel free to open an issue or reach out.


Top categories

Loading Svelte Themes