This repository functions as the basis of the quiz project in the Browsers module. Before the first group meeting, have a look through this code and try to understand how it works and how it is organised. We will explain the idea behind the structure below as well as the Backlog (which will identify what is needed to be implemented).
We have already implemented a very basic UI that can go through the questions to show you how this kind of code is split and how you can use the structure to your advantage. Have a look through it before your first group meeting as it can take a little while to get your head around it!
To run this project locally you will need to open index.html
in your browser using a local server. LiveServer, http-server
, study-lenses
, or any other local static server will work.
There are no dependencies needed to run the website, everything is prepared to work with vanilla JavaScript. However, if you want to install prettier for this project then run (generally you always want to do this if you see a package.json
file):
npm install
Let's run through the folders:
public
src
└── pages
└── views
└── app.js
└── constants.js
└── data.js
└── router.js
index.html
public
this contains the static files that can be used by ourindex.html
filesrc
this contains all of our JavaScript codepages
this folder contains our functions that handle user interactions. You can also see it as the code that processes and updates the data or DOM it also contains our code that links up our handler code to the DOM.views
this contains code to define what the DOM will look like. They will create the DOM element and give it back. They should never read from/write to the dom, that is what the pages do.app.js
this file our initialisation code. Generally this code should only run once and starts the applicationdata.js
this is our data model. Anything we need to store in the browser we place inside the data filerouter.js
this file will transition the app from one page to the other and clear the HTML.
So what should be built? Below is a collection of user stories you can choose from. Stories inside of each priority level are not necessarily in order, it's up to your group to decide how they fit into your strategy. These are also just suggestion, feel free to change them or create your own! Feel free to get creative.
these are necessary for basic usability
- A user can see one question at a time, stepping through the quiz
- A user can select an answer for each question
- A user can know which questions they got correct and incorrect (either immediately or at the end of the quiz)
- A user can see the correct answer for questions (either immediately or at the end of the quiz)
- A user can see their score at the end of the quiz
if time, add more features!
- A user can see their score update in real-time as they select answers
- A user can refresh the page and still have his/her given answers available
- A user has access to resources for further study on each question
- A user can "cheat" to see the correct answer, this forfeits the question
- A user can get more points for fast answers (if your quiz works like a test)
- A user can learn the about the correct answer and look into resources (if your quiz is more educational)
- Transition between pages or question look fancy like TypeForm for example
- Anything else you can think of... go nuts!