beckpull / break-the-scroll

MIT License
0 stars 1 forks source link

Contributors Forks Stargazers Issues MIT License


Logo

Break the Scroll!

The ultimate tool to help users engage their mind and unplug from their phone
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Usage
  3. Roadmap
  4. License
  5. Contact

About The Project

This webpage is meant to encourage users to stop the mindless scrolling on TikTok, Reddit, Instagram, or whatever media they’re too plugged into. When users scan the QR code, they’re presented with a trivia game that is meant to engage their mind, and then they’re given a suggestion of something to do that’s not on their phone.

(back to top)

Built With

(back to top)

Usage

When users scan the QR code below, they're taken to the "Break the Scroll!" game.

Logo

When users begin the trivia game, they are first asked to choose a category and difficulty. The button clicks for the category and difficulty are used to define the parameters of the trivia fetch URL. After these parameters are established, a unique token is appended to the end of the URL which ensures that questions will never repeat for that game.

The categories the user is presented with

The user then has 120 seconds to answer as many trivia questions as they can in their respective category. For each question they answer, a five second timed modal pops up telling them if they got the answer correct or incorrect. The main timer countdown pauses during the presence of the modal.

The categories the user is presented with

When they reach the end of the trivia game, they enter submit their name to appear on a high score page. Their information is stored in local storage so that it persists upon repeat playthroughs.

The categories the user is presented with

On the high score screen, they can see their scores for this game and past games. This is also the point where they are presented with a suggestion on something to do off their phone. They can either choose to comply with the suggestion or decide to play the game again.

The categories the user is presented with

(back to top)

Roadmap

Below is the project roadmap that was used in the planning, development, and deployement phases of the "Break the Scroll!" project:

The categories the user is presented with

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

This application uses data from the OPEN TRIVIA DATABASE API by [PIXELTAIL GAMES LLC.], available under the [Creative Commons Attribution-ShareAlike 4.0 International License]

This application uses data from the Bored API by [Bored API], available under the [Creative Commons Attribution-ShareAlike 4.0 International License]

This project uses the following third-party libraries:

Contact

Becky Feltman - https://github.com/beckpull

Silvia Reyes - https://github.com/NathaliaReyes

Jordan Heersink - https://github.com/jheersink8

Project Link: https://github.com/beckpull/break-the-scroll

(back to top)