devofthings / quiz2go

editable quiz based on js

The Editable Web Quiz

       

An editable quiz based on javascript to learn for everything.

• for mobile and desktop enviorments
• 1 to 4 answer Buttons
• 100% offline! (after setup)

Features

You can select the rounds to play, the time you have to answer per question in seconds and it's also possible to upload and even create your own questions with ease. You can also save, load and delete your stats.

Setting up & Running

git clone https://github.com/saiij/editable-web-quiz.git
cd editable-web-quiz/
npm install
# Open src/index.html in your default browser e.g.
open src/index.html

Contributing

Please follow our Contribution Guidelines.

Create and download your own questions

To create your own questions you click on the 'Create Question' button. Type in a question and at least one answer and then select the correct answer with a double tap. As next, you click on the 'Add Question' button to save the question. If you have at least two questions saved, the download button becomes enabled and you can download your questions.

Use your own questions

To use your own questions you just need to select them via the 'Browse...'-button. Then you set up the rounds to play and time to answer fields and click on 'New Game'. At this moment your questions will load and you can learn for everything.

Screenshots

Built With

Bootstrap 4 - Framework for developing responsive, mobile first projects on the web.
particle.js - A lightweight JavaScript library for creating particles

License

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

Acknowledgments

Special thanks to Nordiii for providing me with useful random knowledge.

Contributors

• Rohit Raj Anand
• Praveen Kumar Purushothaman (GitHub • Blog)
• Victoria Zhong
• Susan Truong
• Dina Elhanan
• Khaled Touaibia

quiz2go's Issues

Scribble / Draw or Code a better Menu for this Quiz.

Problem:

The User Interface especially the main menu is pretty clunky. To not confuse the user too much. The Menu must become lighter.

How To:

If you want to take on this you can scribble/draw/code a new menu. Feel free to add your name on the Readme and also on the footer. After this make a pull request.

Add an exit without save option

Problem:

At the moment you can only 'save & exit' the game. It would be great to have the possibility to exit the game without saving.

How To:

You need to create a new Button with Bootstrap4. To delete saved values you can reuse the delete function. Feel free to add your name to the readme and the footer!

[EASY] Add questions to the quiz. Remains open feel free to contribute!

Problem:

This quiz needs more questions.

How To Contribute:

In src/js/demo.js you find the actual demo-questions. Add more questions with 4 possible answers. Please make sure that these use the following format:

{
    "question": "What or who is 'Dracula vampira'?",
    "answerA": "person",
    "answerB": "plant",
    "answerC": "animal",
    "answerD": "club",
    "correct": "answerB",
    "category": "biology"
},

Don't get confused, the old questions don't have the category field.

Feel free to add your name to the README.md file under Contributors.
If you enjoy this quiz you may want to give it a ⭐.

Happy Hacktoberfest @ALL !

Demo Question on start when new Questions get uploaded

When you start a game and uploadyour own questions. Sometimes the first question is still a question from the demo quiz

[EASY] Play the quiz and make an improvement proposal. Remains Open.

Problem:

To optimize the game we need some feedback about missing features and bugs but we don't have any.

How To Contribute:

To solve this issue you have to play the quiz and write an improvement proposal in the IMPROVEMENTS.md file and after that create an Pull Request.

How To Play:

Read the README.md file and follow the instructions alternatively you can just download the latest release, unzip it and open the index.html.

• If you want a feature that is currently not available write it in the file under Features.
• If you find a Bug create an Issue and/or write it down in the file under Bugs.
• If you want to provide some feedback that would be great too. Just write 2 or 3 sentences.

This issue remains open till the end of the Hacktoberfest to (hopefully) get more feedback.

Timer Fix

Problem:

The Timer bugs(Resume with next question or just fill the bar again) when you save and exit a game and then play with this savegame again.

How should it be:

The save function should create a "frozen game" like a pause Button so when you resume the game continuous exactly on this Question with the correct amount of time left.

[EASY] Update the Readme.md file with shields

Problem:

The Readme file is not up to date. It needs more 'style' with Shields.io.

How To:

Add a shields for

• the correct license (MIT)
• the actual release version
• total amount of forks

Feel free to also add to your name to the readme file.

Help:

Checkout shields.io for more Information and this example Readme for even more help.

Example:

[EASY] Add categories to the questions.

Problem:

We've collected a bunch of questions together.
Now we need to tag them with a category so they can get accessed in another way in a future release.

How To:

In src/js/demo.js you find the actual demo-questions. Refactor the questions with a category like this:

{
    "question": "What or who is 'Dracula vampira'?",
    "answerA": "person",
    "answerB": "plant",
    "answerC": "animal",
    "answerD": "club",
    "correct": "answerB",
    "category": "biology"
},

Feel free to add your name to the README.md-file. If you like the quiz give it a ⭐!

Make the timer bar smoother

Problem:

The timer ticks down every second. That makes the timer bar very volatile.
It would be better if the timer bar ticks down smoother maybe every 10ms or so while the timer itself still counts in seconds.

How to contribute:

Fix the issue and feel free to add your name to the readme file.