Getting Started

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!

Development

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.

Installing Dependencies

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

Structure

Instead of writing all code in a single JavaScript file, we want you to split your code over several files. The structure of this project is explained in the next video

Let's run through the folders:

public
src
└── pages
└── views
└── app.js
└── constants.js
└── data.js
index.html

public this contains the static files that can be used by our index.html file
src this contains all of our JavaScript code
- pages 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 application
- data.js this is our data model. Anything we need to store in the browser we place inside the data file

Goal and Backlog

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.

Choose a desired end result at the start of the project. By choosing an existing example, the goal of the project will be clear to everyone in the team. Another benefit is that it will be easier to come up with the necessary tasks to create your quiz.

Some examples of online quizes that you might like:

When you have chosen your goal, you can create tasks as issues on Github and assign them to team members. Tasks could look like this, using the MoSCoW labels for prioritization

(must have) A user can see one question at a time, stepping through the quiz
(must have) A user can select an answer for each question
(must have) Change the <title>
(must have) add a favicon
(should have) A user can see what the correct answer is after they selected their answer.
(should have) A user can see their score update in real-time as they select answers
(should have) A user can refresh the page and still have his/her given answers available
(could have) A user can "skip" the question and learn the correct answer, this forfeits the question
(could have) Transition between pages or question look fancy like TypeForm for example

You should create tasks that fit with your goal, these tasks serve just as an example.

mnvacym/browser-quiz-project-starter

Getting Started

Development

Installing Dependencies

Structure

Goal and Backlog