Skip to content

This project scored second in Code Institute 2023 Halloween Hackathon. Its a fun sound guessing game, its really spooky check it out!

Notifications You must be signed in to change notification settings

alex025x/Didyouhearthat

 
 

Repository files navigation

🎃🎃🎃 Phantom Forge: A Halloween Hackathon 🎃🎃🎃

PhantomForgeBanner

DID YOU HEAR THAT?

by the GhoulGroovers

Deployment

The project is deployed and can be accessed at Didyouhearthat.

Banner

ABOUT

Intro

This quiz tests the user's knowledge of Spooky Sounds from their favourite Halloween films.

Listen to the audio and see if you know how the sound was made.

Goal

  • The goal of this project was to create an interactive Halloween themed quiz.

  • It provides a fun and challenging way for users to test how well they know the classic Halloween sound effects from their favourite spooky films.

  • The target audience for this project is anyone who has seen a Halloween film.

  • The quiz is an entertaining twist on the classic JavaScript quiz allowing the user to get into the Halloween spirit with its on theme styling and design.

Collaborators

  • Rachel Walmsley - the Scrum Master Extraordinaire
  • Kyle Clow - the Seasoned Sage
  • Ulrike Riemenschneider - the JavaScript Juggler
  • Sarah Barter - the Multitasker Dynamo
  • Natalia Czeladka - the CSS Wizard
  • Alexander Lungu - the Sound Ninja

User Stories

  • Welcome Page - As a visiting user, I want to see the rules of the quiz and to be able to input my name. I then want be able to start the quiz.

  • Game Selection Section - As a visiting user, I want to be able to choose between Old Classic movie sounds or New Movie sounds.

  • Game Main Section - As a visting user, I want to be able to see the audio and connecting answers. I want to see my score recorded.

  • End Section - As a visiting user, I want to see my final result after completing the quiz and have the option to take the quiz again.

  • High Score Page - As a visiting user, I want to be to see my top three scores after playing the quiz.

  • Creators Page - As a visting user, I want to be able to learn more about the creators of the app.

Features

  • Nav Bar - The title of the quiz is visible next to the app's logo. The title acts as a link to the main page of the quiz. To the right there are links to the pages "Halloween Quiz" (the main quiz page), "High Score" (a page listing the user's high scores),and "Creators" (a page giving details on the app's creators). The same nav bar is displayed on every page of the app. On small screen devices the nav bar displays the app name and logo and a burger menu for the other page links.

  • Quiz rules - The user will see the quiz rules on loading the app for the first time.

  • Username input - The user is invited to type in their name. This makes the app more personal and will be used to engage the user at the end of the game and on the High Score page.

  • Quiz Start Section - A welcome message is displayed and the user is asked to choose between Old Classic Movies or New Movies. The quiz section then displays the first question showing the title of the film, the audio file, and three answer options. The user will see the total number of questions in the quiz and what number question they are answering. They will also see their total correct and total incorrect answers.

  • Quiz End Section - The user will be shown their score for total correct answers out of 10 for their selected round of questions, and they are given a message of support. They will have the option to play again as the same user or to change their username and play again. They can also navigate to the high score page.

  • High Score Page - The user will see their name and their high scores displayed. If they play more than once with the same username they will see their top 3 results.

  • Creators Page - The names of all the contributing developers are displayed along with links to their GitHub profiles, LinkedIn profiles.

  • Footer - The copyright for the app is displayed. There is also a link to the app creators page. The same footer content is displayed on every page.

Future Features

  • A submit button under the three answer options that the user will click after making their answer selection - this will improve UX and adhere to defensive design principles.
  • A separate page displaying the instructions - Currently, the instructions are displayed only once when the user first loads the game to input their name. Even though the game is quite straight forward in terms of its rules, we would like to add a separate instructions page so that the user can navigate to that should they require to.
  • Correct or incorrect answer hightlight - We would like to have the selected answer option be highlighted in green if it is correct or else in red if it is incorrect. Currently the user can see if they were correct/incorrect as the score increments after each question is answered. But having a highlight feature would improve the UX of the app.

Future Enhancements

  • To prevent the ghost that haunts the app from passing over the quiz game section and blocking the user's access to clicking play on the audio or clicking on any of the answer options.
  • To have the answer options displayed in a random order so that if the game is played multiple times by the same player they will not see the answers displayed in the same order every time.

Design

Colour Scheme

The colour scheme of "Did you hear that?" Halloween Sounds Quiz was generated from its background picture. Because it plays a crucial role in setting the tone and atmosphere of the app, we all wanted to introduce colours commonly associated with Halloween, such as black, grey, and orange. Keeping the page simple and clear was our highest priority, so choosing the classic combination of black and white was a pretty obvious choice here. A few subtle shades of grey and blue emphasize the dark night design, but the cherry on the cake and the strongest colour accent of the website is a mid-toned, golden ochre shade called buff, our subdued equivalent of flashy orange.

We used Coolors to generate our colour palette.

Colour Palette

Typography

To emphasize the contrast between different level headings, we have carefully selected two different fonts. They are both Google Fonts, but that's where the similarities end. The fonts were paired to enhance the visual hierarchy of the website and highlight essential information.

  • The Crimson Text font is the primary font used throughout the entire website, with Serif as the fallback font. It's a clean and legible font that ensures easy readability. We mainly used it to provide text content for paragraphs, quiz answers, and short notes (e.g. in the footer).

Crimson Text Font

  • The Creepster font was used for almost all of the main headings and the logo. It's a bold and eye-catching font that easily draws attention, also a perfect match for our Halloween theme with its spooky curves and horror-related design.

Creepster Font

  • Font Awesome icons were used for social media links and spider-shaped bullet points.

Wireframes

Wireframes1

Wireframes2

Technologies Used

Languages Used

  • HTML - used for the main site content.
  • CSS - used for the main site design and layout.
  • JavaScript - used for user interaction on the site.

Frameworks, Libraries and Programs Used

  • Am I responsive? - used to check the site's responsiveness and to create mockups.
  • Bootstrap v5.3 - used to assist with responsiveness by utilizing its components and layout elements.
  • Coolors - used to create the colour palette.
  • Font Awesome - used to provide icons across the website.
  • Free Convert - used to convert jpg/png images to webp format.
  • Google Chrome Dev Tools - used to inspect and debug the code.
  • Google Fonts - used to import the fonts that style all of the text content.
  • Git - used for version control by utilizing VS Code's terminal.
  • GitHub - used to store the project's code and images in the repository.
  • GitHub Pages - used to deploy the website.
  • Icon-Icons - used to provide the favicon.
  • Tiny.png - used to reduce the size of the image files.
  • Visual Studio Code - used as a code editor.

Testing

Please follow this link to the separate Testing documentation.

Depolyment

GitHub pages for deployment

The steps taken to deploy the project:

  1. Naviagate to Settings on the GitHub repo page.
  2. Click on Pages.
  3. Click deploy from branch.

To clone the repo:

  1. On GitHub click on the green <> Code button,
  2. In the dropdown menu select Local and copy the url for the repository.
  3. Create a file on your desktop and right click to open with code, i.e. your local environment.
  4. On the welcome page select the option Clone Git Repo and paste the URL.
  5. Save it to the folder you created on your desktop.

Credits

Code from the team's projects

The team combined code from personal quiz projects:

About

This project scored second in Code Institute 2023 Halloween Hackathon. Its a fun sound guessing game, its really spooky check it out!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 57.4%
  • JavaScript 35.7%
  • CSS 5.2%
  • Dockerfile 1.7%