Skip to content

Tori-coder/Project-2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ENGLISH IDIOMS QUIZ

Code Institude Second Portfolio Project HTML, CSS and Javascript

This is a quiz designed to test the user's understanding of the meanings of English idioms. It was inspired by my work as a teacher of English as a Foreign Language.

Visit the live site here

mock-up

CONTENTS

  1. Design
  2. Features
  3. UX
  4. Testing
  5. Credits

DESIGN

Wireframes

Wireframes were sketched by hand.

The styling was deliberately kept simple in order to spend my limited time concentrating on the javascript.

wireframes

Background and Colour Choices

The background quiz image was chosen from shutterstock.com and the colour palette created using coolors.co

Fonts

The main header is styled in Cupcake, from befonts.com.

Secondary headers are in TheArtistSans, also from befonts.com.

The displayed idiom and answer section are in Times New Roman.

Button text is the default button font.

FEATURES

Contents

Header

The header contains the quiz name and explanation of what the quiz tests.

Header

Quiz interface

  • The quiz interface consists of an idiom and three buttons with alternative meanings. The user is instructed to click a button to choose the correct meaning of the idiom.
  • On selection of one of the buttons, the user is informed if their choice is correct or incorrect, and the score is amended accordingly. Pressing the "next idiom" button loads the next idiom.
  • There are ten idioms per quiz. At the end of the quiz, the user is informed and a "start new quiz" button is displayed, which runs the quiz again when clicked.

Quiz

Footer

The footer contains credit and link to my github page

Footer

Potential Future Features

Owing to a leave of absence and a tight deadline on my return to the course, I was unable to include many features that I wanted to. I shall continue to work on these after submission.

  • A start screen with feature for users to enter their name - see Unfixed Bugs below
  • A high scores table
  • A feature to download correct answers for future learning
  • A better styled alert for correct/incorrect answers, including moving images and sound
  • The javascript should be refactored to reduce repetition

UX

Visitor Objectives

  • Instantly understand who and what the quiz is for;
  • Be able to navigate the quiz easily;
  • Understand the rules of the quiz before starting the game;
  • Know the score during and after playing the quiz

TESTING

Fixed Bugs

  • On first testing it was possible to click the option buttons more than once, allowing more than one guess per idiom. The event listeners were moved in the javascript so that after one guess the user has to click "next idiom".
  • Further user testing revealed one of the answers in the array to be wrong. The array was corrected.

Unfixed Bugs

  • I attempted to add a start screen to input user name (to be used later with the end of quiz message). The code is contained in the start-screen branch. However, hiding the start screen changed the flow and caused the quiz itself to display below the main quiz area (the html was rendering with the quiz-container AFTER the section).
  • Screenshot below.
  • My research and exhaustive troubleshooting failed to identify the cause of this bug. As a result the branch was not merged to main. The start screen feature is included in Potential Future Features.

start-screen-html start-screen

Validation Testing

HTML and CSS

W3C was used to validate the HTML. Passed.

W3C jigsaw was used to validate the css. Passed.

Javascript testing

jshint was used to validate the javascript. No errors found.

Chrome Developer Tools Lighthouse rating

Lighthouse Rating

Browser Testing

Browser Layout Functionality
Chrome
Edge
Firefox
Safari

Manual Testing

Each time a feature was added, all the functions were tested to see if there was an impact.

The quiz was manually tested by a number of users on various devices. The quiz was played through various rounds. All features were found to function correctly.

Deployment

The site was deployed on github pages from the main branch by the following steps:

  • Git Hub repository choose Settings tab and Pages
  • From drop down menu source section pick main branch
  • Once the Save button is clicked the page provides the link to the completed website.(https://tori-coder.github.io/Project-2/)

CREDITS

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published