Giter VIP home page Giter VIP logo

wbwren-waste-matters_mayresub's Introduction

Waste Matters

Table of Contents

Table of contents generated with markdown-toc

Project purpose

Waste matters Ltd. offers waste and recycling solutions to Irish businesses. The interactive demo aims to advertise and sell polystyrene compactors. The demo will guide the user through a mini-game in which they will drag and drop polystyrene blocks into a compactor machine before turning it on. While interacting with the demo, the user will receive key facts about polystyrene recycling and waste matters. On completion of the demo, the user will have the option to ‘learn more’ which will lead them to the current waste matters website.

UX

User stories

  • As a user, I would like the user experience on the website to be intuitive.

  • As a user, I want to learn about polystyrene compactors and how they work.

  • As a user, I want to learn about polystyrene recycling in an engaging manor.

    • The interactive demo requires user engagement while the website provides key information
  • As a user, I want my experience on the website to be enjoyable.

Strategy

Goal: To inform users about polystyrene recycling in an engaging manor and sell polystyrene compactors through waste matters Ltd.

Scope

  • An interactive demo utilizing Matter.js, a 2D rigid body JavaScript physics engine.

Surface

Color Scheme

  • Font color: #f0f8ff
  • background color: #14151F
  • User instructions: #ff0000

Typography

Roboto Mono is the font used on the webpage with monospace as the fallback font in the case of the default font failing to load correctly. The default font weight of 400 is used throughout the page.

Imagery

  • The imagery is cartoon-like in style.

Wireframes

Features

This project is an interactive game built on the 2d physics engine matter.js. It allows users to place polystyrene objects into a compactor and turn it on. This game serves the purpose of engaging the user and allowing for an alternative way of imparting information. Facts about polystyrene recycling, polystyrene compactors and waste matters appear as the user interacts with the demo.

Technologies Used

Languages used

  • HTML5
  • CSS3
  • JavaScript

Frameworks, Libraries & Programs Used

Testing

Code Validation

  • HTML was validated using W3C Markup Validation Service.

  • CSS was validated using W3C CSS Validation Service - Jigsaw

  • JavaScript was passed through the linter jshint with no warnings

Functionality test

Num Test Action Outcome image Result
1 Navigation bar links work correctly Click on each nav icon Image of navigation bar working Pass
2 The spawn button on the interactive game spawns blocks when pressed and held Click and hold spawn button Image of spawn button working Pass
3 The compact button compacts the blocks and ejects a compacted block Click compact button Image of compact button working Pass
4 The instructions button displays the instructions modal when clicked Click instructions button Image of user instruction modal working Pass
5 The contact form does not a blank submission Attempt to submit blank form Image of form failing to submit while blank Pass
6 The contact form inputs only accept valid inputs Attempt to enter invalid data types Image of form requiring correct data format Pass

Browser Compatibility

Num Browser Test result
1 Chrome Passed
2 Opera Passed
3 Mozzilla Passed

Responsiveness Testing

  • Chrome developer tools was used to test a wide variety of device sizes and resolutions.

  • The website has been tested on an iPhone 5, Samsung Galaxy s10, Acer swift 3 and a desktop PC with a 1080p and 4k monitor.s

Google Lighthouse Scores

Deployment to Github Pages

  1. Create a Github account at github.com

  2. Click on the 'New' button in the top left corner

  3. Enter a name for the repository, check the 'Add a README file' box

  4. Click 'Create repository'

  5. Open the repository in preferred integrated development environment

  6. Save changes by clicking the save button

  7. Once a feature has been successfully created using the 'git add .' command to stage the changes made

  8. Then use the command 'git commit -m"[enter commit title here]"'

  9. All meaningful changes to the code should have its own commit

  10. To push the commits to Github use the command 'git push'

  11. Once the website is ready for deployment return to github.com

  12. Click on the 'settings' tab

  13. Scroll down to the 'GitHub Pages' section

  14. Click the 'None' dropdown button

  15. Select the master branch

  16. Click save

  17. After a few minutes, the site will be published to GitHub pages and can be accessed using the URL at the GitHub Pages section

Clone

  1. Follow this link to my Github Repository.

  2. Click 'Clone or Download'.

  3. In the Clone with HTTPs section, click the 'copy' icon.

  4. In your local Integrated Development Environment open Git Bash.

  5. Change the current working directory to where you want the cloned directory to be located.

  6. Type 'git clone', and paste the URL you copied before.

  7. Press enter and your local clone will be available.

Credits

Media

Acknowledgments

wbwren-waste-matters_mayresub's People

Contributors

wbwren avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.