Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request to Add Quiz App Assignment to the Repository #515

Open
4 tasks done
adityakrmishra opened this issue Jan 9, 2025 · 0 comments
Open
4 tasks done

Request to Add Quiz App Assignment to the Repository #515

adityakrmishra opened this issue Jan 9, 2025 · 0 comments
Labels
Status: Needs Review This issue/PR needs an initial or additional review

Comments

@adityakrmishra
Copy link

Prerequisites

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • I have searched the existing issues to ensure this improvement hasn't been suggested before (please have a look through our open issues list to make sure)
  • The title of this issue follows the <Location of the improvement>: <Brief description of the improvement> format, e.g. Exercises: Add exercise on XYZ
  • (Optional) I am interested in working on this issue and would like to be assigned to it

Improvement Description

Summary:

I would like to propose adding a new assignment to the repository, titled "Quiz App". This assignment is designed to help users practice JavaScript concepts such as arrays, loops, functions, and user input handling. The assignment includes a main application file, comprehensive documentation, a solution file, and a detailed explanation of the solution.

Assignment Details:

Assignment Name: Quiz App

Description:

A command-line application that tests users' knowledge through multiple-choice questions.

Learning Objectives:

Understand and implement basic JavaScript concepts.

Handle user input using the readline module.

Develop logic to display questions, check answers, and track scores.

Files Included:

quizApp.js: The main application file containing the quiz logic.

README.md: Documentation providing an introduction, features, instructions, and solution guide.

solution.js: The solution file demonstrating the expected implementation.

solutionExplain.md: An explanation of the solution, including key details and clarifications.

Justification: This assignment will be a valuable addition to the repository as it provides a practical and engaging way for users to reinforce their JavaScript skills. The structure of the assignment ensures that users can understand the problem, implement the solution, and learn from the provided explanation.

Additional Notes:

The assignment is designed to be beginner-friendly and offers step-by-step instructions to guide users through the process.

Contributions and feedback are welcome to improve the assignment and provide additional features or questions.

Thank you for considering this request. Please let me know if there are any questions or further clarifications needed.

Acceptance Criteria

Functionality:

The quizApp.js file must include the following functionalities:

Display multiple-choice questions to the user.

Allow the user to select an answer for each question.

Check the user's answer against the correct answer.

Track and update the user's score.

Move to the next question after the user provides an answer.

Display the final score at the end of the quiz.

Documentation:

The README.md file must provide:

An introduction to the Quiz App.

Detailed features of the app.

A way to understand and solve the assignment.

Instructions on how to run the app.

Solution File:

The solution.js file must:

Contain the complete and correct implementation of the Quiz App.

Follow the same structure and logic as quizApp.js with correct answers.

Solution Explanation:

The solutionExplain.md file must:

Provide a detailed explanation of the solution.

Describe the key parts of the code.

Explain the logic and structure used to solve the assignment.

Code Quality:

Code in quizApp.js and solution.js must be:

Well-commented for clarity.

Free of syntax and logical errors.

Easy to read and understand.

Testing:

The Quiz App must be tested to ensure:

All questions are displayed correctly.

User inputs are handled appropriately.

Correct answers are identified accurately.

The score is updated correctly.

The final score is displayed correctly at the end.

User Experience:

The app must provide a clear and interactive user interface through the command line.

Feedback for correct and incorrect answers must be displayed to the user.

The final score must be presented in a user-friendly manner.

Additional Notes
The assignment should be designed to be beginner-friendly, with clear instructions and comprehensive documentation.

The app should be robust and handle edge cases gracefully, such as invalid user inputs.

(Optional) Additional Comments

I'm excited to contribute the Quiz App assignment to this repository as I believe it will be a valuable resource for learners looking to enhance their JavaScript skills. The assignment is structured to be engaging and educational, providing a practical application of key JavaScript concepts. I am open to feedback and suggestions to improve the assignment and make it even more beneficial for the community.

Thank you for considering this contribution. I look forward to your feedback and the opportunity to collaborate with the team.

@adityakrmishra adityakrmishra added the Status: Needs Review This issue/PR needs an initial or additional review label Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review This issue/PR needs an initial or additional review
Projects
None yet
Development

No branches or pull requests

1 participant