brodsa / climate-memory Goto Github PK

The Climate Memory website was created to raise awareness of climate change. The website attempts to present the facts about how human activities affect nature and the lives of other people, including our children.

The website was developed as a memory game with additional features. In contrast to the classical memory game, the user tries to match an image with a corresponding image description. The content of the flipped card is always magnified in order to read the text or see the image properly.

The game is particularly suitable for adults or children who can already read. The website could be used in schools for educational purposes as it provides evidence-based facts.

Click here to view the website and to play the game!

• UX
• Features
• Testing
• Deployment
• References
• Acknowledgements

The purpose of the game is to communicate the facts about the climate change in an appealing and user-friendly way. The game is fun and informative at the same time. Moreover, the game can be played on various devices.

• First-Time User Goals

  • US1: As a first-time visitor, I want to understand the purpose of the gama.
  • US2: As a first-time visitor, I want the game to be fun and interactive.
  • US3: As a first-time visitor, I want to find out interesting information about the climate change.
  • US4: As a first-time visitor, I want to understand the game rules.
  • US5: As a first-time visitor, I want to play the game on my mobile phone.
  • US6: As a first-time visitor, I want to easily navigate through the webpage content.

• Returning Visitor Goals

  • US7: As a returning visitor, I want to find out more facts about the climate change.
  • US8: As a returning visitor, I want to suggest the developer include additional facts or provide him with feedback.

The wireframes of the website were designed using Balsamiq. Two different layouts were mainly considered:

• Desktop Wireframe

• Mobile Wireframe

Fonts were selected based on the fontpair. The fonts were included in the web page via the link tags, which were generated using Google Fonts.

• Montserrat was chosen for headings.
• Hind was taken for the body text, such as paragraphs.

The color palette that was chosen is coolors, with a slight modification. The final colors include Eerie Black and Alice Blue, see here.

The chosen colors were evaluated in terms of accessibility using the toolnes tool. The resulting accessible color matrix revealed the following suggested combinations.

The website layout reflects the user stories as well as the components or functionality, which are common practices in web design, including responsiveness (US5). In addition, the interactive elements were designed to provide the user with feedback on the conductive activities.

• Header

  • The Header component is located at the top of the website.
  • The Header component displays the logo of the game.

  

• Footer

  • The Footer component is located at the bottom of the website.
  • The Footer component displays the developer name and a link to the GitHub profile.

  

The homepage contains a white board located in the middle of the screen. The board introduces the game (US1) and asks the user to contact the developer in order to expand the content of the game. In addition, there are four navigation buttons (US6).

The buttons direct the user to other webpage parts:

• "How to play" navigates the user to the game instructions (US4). The information is provided in the pop up window. In the window, there is also the button "Start game", which gives the user the possibility to start playing the game from there, see How to play Modal.
• "Start game" navigates the user to the game board, which is located on a separate page, see Game Board Features Section.
• "Story behind" navigates the user to the story behind the game. The story is provided in the pop up window, see Story behind Modal
• "Contact me" navigates the user to the contact form in the pop up window (US8). The contact form includes buttons for sending and clearing the provided information, see Contact me Page

The game board is located in the middle of the webpage.

The game board contains the following static and interactive elements:

• Card Board

  • The board consists of six card pairs, leading to 12 flip cards in total. Each pair is represented by a text and an image card. The text was selected by the developer and attempts to present interesting facts about the climate change (US3). The image card can be an icon, a figure, or a picture, that is somehow related to the text.
  • The card board is fully built with JavaScript. The data are located in the json file and contains information for nine card pairs. When the user clicks on Start game, the data cards are randomly selected. Thus, the user can play with a different set of cards (US7).
  • The user is allowed to click on two cards only. When the user clicks on a card, the card is flipped and automatically magnified to read the text and see the image properly. To close the magnified card, the user has to click on it again. Four situations can occur (US2):
    • The card stays flipped if it is the first flipped one.
    • The cards flip back in case of no match.
    • The cards stay flipped if they match.
    • The card is flipped back in case the same card was flipped.
  • Several examples of the flipped card are listed below (US2):
    • A text card is flipped
    • An image card with an icon is flipped
    • A image card with a figure is flipped
    • Two cards match
    • All matches are founded

• Score Board

  • The score board is shown right after the card board.
  • The board displays the number of flips and the time spent playing the game.

• Navigation Board

  • The navigation board is located on the button of the game board (US6).
  • The board displays two buttons:
    • Refresh Button refreshes the game, and the user starts the game from the beginning
    • Home Button navigates the user back to the homepage.

• Win Board

  • When all cards are flipped, the win board pops up. The board shows the logo, the final number of flips, and the total time needed to reveal all cards (US2).
  • The board automatically disappears, and the user can start the new game by clicking on the Refresh Button.

The webpage additionally contains two hidden pages:

• Thank you page is shown after the form submission.
• 404 page is displayed in the case of an invalid URL.

• Additional Features

  • The Header and Footer components were originally not considered in the design.
  • The Contact Me modal was added to enable contacting the developer.

• Not yet implented Features

  • Topics
    • The initial plan was to have the cards separated into topics, which the user could select. This will be implemented in the next iteration.
    • Possible solution is mainly to modify the data load in order to generate the card content.
    • The pop up window offers the user to click on different buttons related to the different topics.
    • Each topic is related to a separate json file, containing the data to generate the cards.
    • The buttons have the event listener on click, firing the load data function. The function received the path to the json file depending on the selected topic.
    • This would require selecting all buttons with a specific data attribute and using the switch operator to get the correct data, i.e. load the correct data.
  • User Chart or Progress
    • There are two options for implementing this feature in the next iteration - either use the localstorage or the Google sheets API.

• Additional language could be used to target more users.
• More topics were initially planned to make the webpage more interesting and to raise even more awareness.

In general, the website was continuously tested after implementing a feature or styling a component. The main part of testing includes thorough manual testing as well as webpage validation using existing tools, see the detailed testing report. Besides the issues reported in the report, there were other issues to be fixed:

The site was deployed to GitHub Pages. The steps to deploy the webpage were following:

• In the GitHub repository, the Settings Section was selected.
• The Page Category on the left hand side was selected.
• Under the Branch Section, the source branch from the drop-down menu (e.g. master branch) was chosen.
• The Save Button was clicked on.
• The page url was generated, which indicates the successful deployment.

The website can be viewed here

During development, the commit type was included in commit messages, following the blog post.

The repository can also be cloned locally, the steps as follows:

1. On Git
   • Go to the repository, i.e. https://github.com/brodsa/mgv-vorau
   • You see the content of the repository, i.e. all the files are listed. On the right side at the top of the list, find the Code drop down button and click on it.
   • Copy the repository HTTPS link to the clipboard.
2. In the terminal (Note: git must be preinstalled)
   • Open the terminal and navigate, where you want to clone the repository.
   • Type git clone and insert the content from the clipboard, leading to the command git clone https://github.com/brodsa/climate-memory.git.
   • Once the project is cloned, you can start using the repository locally.

• HTML
• CSS
• JavaScript
• Markdown

• JavaScript Tutorial & Documentations
  • Web Dev Simplified
  • JavaScript DOM Manipulation
  • Code with Mosh
  • Memory Game
    • freeCodeCamp
    • Ferenc Almasi
  • Stack Overflow
  • W3schools
  • MDN Web Docs
• Data for the Memory Game
  • Our world in data
  • The Climate Book by Greta Thunberg
  • IEEP
  • Fontawesome
  • Temperature stripes by Ed Hawkins

• Google Fonts was used to import the fonts into the style.css file.
• Color Pallete was used to select accessible colors.
• Image Compressor was used to compress the images.
• Image Converter was used to convert all images in the webp format.
• Favicon was used to generate the code and files for the webpage favicon.
• GitHub was used to store the code and host the website.
• Gitpod is an IDE and was used to develop the website.
• Formsubmit was used for the form submission.
• Mockup Generator was used to generate the mockup for README.
• Balsamiq was used to create wireframes.
• Markdown Generator

I would like to thank my mentors, Gareth McGirr and Daisy McGirr, for their guidance through my project and their valuable inputs. I would like to give a mention to Lammer Helmuth for his time and for giving me valuable feedback on my source code. He has provided me with information about the best practices. And my special thanks go to my husband for being supportive during the development of the webpage.